Jump to

• Request
• Response

v2.0

post

/ec-library-svc/rest/v2.0/libraryObjects/studies/{studyId}/versions/{studyVersion}/{copyObjectMethod}/copyObjects

Copies a library object.

Request

Path Parameters

• copyObjectMethod(required): string
  Copy object method

  Example:

  COPY_LINK

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyVersion(required): string
  Study version

  Example:

  1.0.0.1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object LibraryCopyObjectDtoV2.0
  Title: LibraryCopyObjectDtoV2.0

  Information about a library object copy request.

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

Nested Schema : LibraryCopyObjectDtoV2.0

Type: object

Title: LibraryCopyObjectDtoV2.0

Information about a library object copy request.

Show Source

• associatedForm: boolean
• isAssociatedForm: boolean
  Title: Is associated form

  Indicates whether the form is associated.

  Example: true
• objectGroup: string
  Title: Object group

  Object group or title.

  Example: Demography
• objectId: string
  Title: Object ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying object (for example, forms or rules).

  Example: B1B8327AFAA6412287106192AB5984EF
• objectType: string
  Title: Object type

  Type of the underlying object.

  Example: FORM
• sourceObjectId: string
  Title: Source object ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source object used for copy.

  Example: B1B8327AFAA6412287106192AB5984EF
• sourceStudyId: string
  Title: Source study ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source study used for copy.

  Example: B1B8327AFAA6412287106192AB5984EF
• sourceStudyType: string
  Title: Source study type

  Type of the source study used for copy.

  Example: LIBRARY
• sourceStudyVersion: string
  Title: Source study version

  Version identifier of the source study used for copy.

  Example: 1.0.0.1
• studyId: string
  Title: Study ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example: B1B8327AFAA6412287106192AB5984EF
• studyType: string
  Title: Study type

  Type of the study.

  Example: LIBRARY
• studyVersion: string
  Title: Study version

  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.1

{
    "title":"LibraryCopyObjectDtoV2.0",
    "type":"object",
    "properties":{
        "associatedForm":{
            "type":"boolean"
        },
        "objectId":{
            "title":"Object ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying object (for example, forms or rules).",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "studyId":{
            "title":"Study ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "studyVersion":{
            "title":"Study version",
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.1"
        },
        "studyType":{
            "title":"Study type",
            "type":"string",
            "description":"Type of the study.",
            "example":"LIBRARY"
        },
        "sourceObjectId":{
            "title":"Source object ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source object used for copy.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "sourceStudyVersion":{
            "title":"Source study version",
            "type":"string",
            "description":"Version identifier of the source study used for copy.",
            "example":"1.0.0.1"
        },
        "sourceStudyId":{
            "title":"Source study ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source study used for copy.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "sourceStudyType":{
            "title":"Source study type",
            "type":"string",
            "description":"Type of the source study used for copy.",
            "example":"LIBRARY"
        },
        "objectType":{
            "title":"Object type",
            "type":"string",
            "description":"Type of the underlying object.",
            "example":"FORM"
        },
        "objectGroup":{
            "title":"Object group",
            "type":"string",
            "description":"Object group or title.",
            "example":"Demography"
        },
        "isAssociatedForm":{
            "title":"Is associated form",
            "type":"boolean",
            "description":"Indicates whether the form is associated.",
            "example":true
        }
    },
    "description":"Information about a library object copy request."
}

Examples

Select an example LibraryCopyObjectsRequestV2

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LibraryCopyObjectDtoV1.0

Type: object

Title: LibraryCopyObjectDtoV1.0

Information about a library object copy request.

Show Source

• objectGroup: string
  Title: Object group

  Object group or title.

  Example: Demography
• objectId: string
  Title: Object ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying object (for example, forms or rules).

  Example: B1B8327AFAA6412287106192AB5984EF
• objectType: string
  Title: Object type

  Type of the underlying object.

  Example: FORM
• sourceObjectId: string
  Title: Source object ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source object used for copy.

  Example: B1B8327AFAA6412287106192AB5984EF
• sourceStudyId: string
  Title: Source study ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source study used for copy.

  Example: B1B8327AFAA6412287106192AB5984EF
• sourceStudyType: string
  Title: Source study type

  Type of the source study used for copy.

  Example: LIBRARY
• sourceStudyVersion: string
  Title: Source study version

  Version identifier of the source study used for copy.

  Example: 1.0.0.1
• studyId: string
  Title: Study ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example: B1B8327AFAA6412287106192AB5984EF
• studyType: string
  Title: Study type

  Type of the study.

  Example: LIBRARY
• studyVersion: string
  Title: Study version

  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.1

{
    "title":"LibraryCopyObjectDtoV1.0",
    "type":"object",
    "properties":{
        "objectId":{
            "title":"Object ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying object (for example, forms or rules).",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "studyId":{
            "title":"Study ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "studyVersion":{
            "title":"Study version",
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.1"
        },
        "studyType":{
            "title":"Study type",
            "type":"string",
            "description":"Type of the study.",
            "example":"LIBRARY"
        },
        "sourceObjectId":{
            "title":"Source object ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source object used for copy.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "sourceStudyVersion":{
            "title":"Source study version",
            "type":"string",
            "description":"Version identifier of the source study used for copy.",
            "example":"1.0.0.1"
        },
        "sourceStudyId":{
            "title":"Source study ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the source study used for copy.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "sourceStudyType":{
            "title":"Source study type",
            "type":"string",
            "description":"Type of the source study used for copy.",
            "example":"LIBRARY"
        },
        "objectType":{
            "title":"Object type",
            "type":"string",
            "description":"Type of the underlying object.",
            "example":"FORM"
        },
        "objectGroup":{
            "title":"Object group",
            "type":"string",
            "description":"Object group or title.",
            "example":"Demography"
        }
    },
    "description":"Information about a library object copy request."
}

Examples

Select an example LibraryCopyObjectsResponseV2

500 Response

Error

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