Jump to

• Request
• Response

Copy a library object

post

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

Copy a library object.

Request

Path Parameters

• copyObjectMethod(required): string
  Copy object method
• studyId(required): string(uuid)
  Study id
• studyVersion(required): string
  Study version

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: array

Show Source

• Array of: object LibraryCopyObjectDtoV2

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

Nested Schema : LibraryCopyObjectDtoV2

Type: object

Show Source

• associatedForm: boolean
• isAssociatedForm: boolean
  Is form associated

  Example: true
• objectGroup: string
  Object group (title)

  Example: Demography
• objectId: string (uuid)
  Object (forms, rules...) ID
• objectType: string
  Object type

  Example: FORM
• sourceObjectId: string (uuid)
  Object (forms...) ID
• sourceStudyId: string (uuid)
  Source study id
• sourceStudyType: string
  Source study type

  Example: LIBRARY
• sourceStudyVersion: string
  Source study version

  Example: 1.0.0.1
• studyId: string (uuid)
  Library study id
• studyType: string
  Study type

  Example: LIBRARY
• studyVersion: string
  Library study version

  Example: 1.0.0.1

{
    "type":"object",
    "properties":{
        "associatedForm":{
            "type":"boolean"
        },
        "objectId":{
            "type":"string",
            "description":"Object (forms, rules...) ID",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "description":"Library study id",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Library study version",
            "example":"1.0.0.1"
        },
        "studyType":{
            "type":"string",
            "description":"Study type",
            "example":"LIBRARY"
        },
        "sourceObjectId":{
            "type":"string",
            "description":"Object (forms...) ID",
            "format":"uuid"
        },
        "sourceStudyVersion":{
            "type":"string",
            "description":"Source study version",
            "example":"1.0.0.1"
        },
        "sourceStudyId":{
            "type":"string",
            "description":"Source study id",
            "format":"uuid"
        },
        "sourceStudyType":{
            "type":"string",
            "description":"Source study type",
            "example":"LIBRARY"
        },
        "objectType":{
            "type":"string",
            "description":"Object type",
            "example":"FORM"
        },
        "objectGroup":{
            "type":"string",
            "description":"Object group (title)",
            "example":"Demography"
        },
        "isAssociatedForm":{
            "type":"boolean",
            "description":"Is form associated",
            "example":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LibraryCopyObjectDto v1.0

Type: object

Title: LibraryCopyObjectDto v1.0

Information about library Copy Object

Show Source

• objectGroup: string
  Object group (title)

  Example: Demography
• objectId: string (uuid)
  Object (forms, rules...) ID
• objectType: string
  Object type

  Example: FORM
• sourceObjectId: string (uuid)
  Object (forms...) ID
• sourceStudyId: string (uuid)
  Source study id
• sourceStudyType: string
  Source study type

  Example: LIBRARY
• sourceStudyVersion: string
  Source study version

  Example: 1.0.0.1
• studyId: string (uuid)
  Library study id
• studyType: string
  Study type

  Example: LIBRARY
• studyVersion: string
  Library study version

  Example: 1.0.0.1

{
    "title":"LibraryCopyObjectDto v1.0",
    "type":"object",
    "properties":{
        "objectId":{
            "type":"string",
            "description":"Object (forms, rules...) ID",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "description":"Library study id",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Library study version",
            "example":"1.0.0.1"
        },
        "studyType":{
            "type":"string",
            "description":"Study type",
            "example":"LIBRARY"
        },
        "sourceObjectId":{
            "type":"string",
            "description":"Object (forms...) ID",
            "format":"uuid"
        },
        "sourceStudyVersion":{
            "type":"string",
            "description":"Source study version",
            "example":"1.0.0.1"
        },
        "sourceStudyId":{
            "type":"string",
            "description":"Source study id",
            "format":"uuid"
        },
        "sourceStudyType":{
            "type":"string",
            "description":"Source study type",
            "example":"LIBRARY"
        },
        "objectType":{
            "type":"string",
            "description":"Object type",
            "example":"FORM"
        },
        "objectGroup":{
            "type":"string",
            "description":"Object group (title)",
            "example":"Demography"
        }
    },
    "description":"Information about library Copy Object"
}

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