Jump to

• Request
• Response

v2.0

post

/ec-library-svc/rest/v2.0/libraryObjects

Adds a library object.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : LibraryDtoV1.0

Type: object

Title: LibraryDtoV1.0

Information about a library object.

Show Source

• description: string
  Title: Description

  Description of the library object.

  Example: Advanced demography form
• libraryId: string
  Title: Library ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.

  Example: B1B8327AFAA6412287106192AB5984EF
• libraryVersion: string
  Title: Library version

  Version identifier of the library.

  Example: 1.0
• 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
• status: string
  Title: Status

  Status of the resource.

  Example: DRAFT
• studyId: string
  Title: Study ID

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

  Example: B1B8327AFAA6412287106192AB5984EF
• 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
• tags: string
  Title: Tags

  Comma-separated tags associated with the library object.

  Example: LIB

{
    "title":"LibraryDtoV1.0",
    "type":"object",
    "properties":{
        "libraryId":{
            "title":"Library ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "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"
        },
        "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"
        },
        "libraryVersion":{
            "title":"Library version",
            "type":"string",
            "description":"Version identifier of the library.",
            "example":"1.0"
        },
        "status":{
            "title":"Status",
            "type":"string",
            "description":"Status of the resource.",
            "example":"DRAFT"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the library object.",
            "example":"Advanced demography form"
        },
        "tags":{
            "title":"Tags",
            "type":"string",
            "description":"Comma-separated tags associated with the library object.",
            "example":"LIB"
        },
        "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"
        }
    },
    "description":"Information about a library object."
}

Examples

Select an example LibraryCreateRequestV2

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LibraryDtoV1.0

Type: object

Title: LibraryDtoV1.0

Information about a library object.

Show Source

• description: string
  Title: Description

  Description of the library object.

  Example: Advanced demography form
• libraryId: string
  Title: Library ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.

  Example: B1B8327AFAA6412287106192AB5984EF
• libraryVersion: string
  Title: Library version

  Version identifier of the library.

  Example: 1.0
• 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
• status: string
  Title: Status

  Status of the resource.

  Example: DRAFT
• studyId: string
  Title: Study ID

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

  Example: B1B8327AFAA6412287106192AB5984EF
• 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
• tags: string
  Title: Tags

  Comma-separated tags associated with the library object.

  Example: LIB

{
    "title":"LibraryDtoV1.0",
    "type":"object",
    "properties":{
        "libraryId":{
            "title":"Library ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "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"
        },
        "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"
        },
        "libraryVersion":{
            "title":"Library version",
            "type":"string",
            "description":"Version identifier of the library.",
            "example":"1.0"
        },
        "status":{
            "title":"Status",
            "type":"string",
            "description":"Status of the resource.",
            "example":"DRAFT"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the library object.",
            "example":"Advanced demography form"
        },
        "tags":{
            "title":"Tags",
            "type":"string",
            "description":"Comma-separated tags associated with the library object.",
            "example":"LIB"
        },
        "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"
        }
    },
    "description":"Information about a library object."
}

Examples

Select an example LibraryCreateResponseV2

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top