REST API for Clinical One Platform

Copy forms in bulk

post

/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/copyForms

Copies all the forms passed in request to the given study and version.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E
version(required): string

Study version. Example: "1.0.0.1"

Supported Media Types

Root Schema : schema

Type: array

Show Source

Array of: object CopyFormsV1

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CopyFormsV1"
    }
}

Nested Schema : CopyFormsV1

Type: object

Show Source

formId(required): string (uuid)

Form GUID
studyId(required): string (uuid)

Study GUID
version(required): string

version

Example: 1.3.0.6

{
    "required":[
        "formId",
        "studyId",
        "version"
    ],
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object CopyForms

Title: CopyForms

Information about forms to be copied.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CopyFormsResponse"
    }
}

Nested Schema : CopyForms

Type: object

Title: CopyForms

Information about forms to be copied.

Show Source

studyId: integer (int64)

Study GUID

{
    "title":"CopyForms",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"integer",
            "description":"Study GUID",
            "format":"int64"
        }
    },
    "description":"Information about forms to be copied."
}

500 Response

Error

Root Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object