Jump to

• Request
• Response

V2.0

post

/ec-designer-svc/rest/v2.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 (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Query Parameters

• include: string
  Optional include filter for copy behavior. Optional.

  Example:

  dependencies

Supported Media Types

• application/json

Request Body - application/json ()

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/CopyForms"
    }
}

Nested Schema : CopyForms

Type: object

Title: CopyForms

Information about forms to be copied.

Show Source

• formId(required): string (uuid)
  Form GUID
• studyId(required): string (uuid)
  Study GUID
• version(required): string
  version

  Example: 1.3.0.6

{
    "title":"CopyForms",
    "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"
        }
    },
    "description":"Information about forms to be copied."
}

Examples

Select an example copyFormsV2Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

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

Back to Top