Jump to

• Request
• Response

v2.0

get

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

Gets a library objects with pagination depending on query parameters

Request

Query Parameters

• excludeStudyId: string(uuid)
  excludeStudyId

  Example:

  B1B8327AFAA6412287106192AB5984EF

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

• limit(required): integer(int32)
  Minimum Value: 0

  limit

  Example:

  50

• objectGroup: string
  objectGroup

  Example:

  Demography

• objectGroupEquals: string
  objectGroupEquals

  Example:

  Demography

• objectId: string(uuid)
  objectId

  Example:

  B1B8327AFAA6412287106192AB5984EF

• objectType: string
  objectType

  Example:

  FORM

• offset(required): integer(int32)
  Minimum Value: 0

  offset

  Example:

  0

• onlyRoot: boolean
  onlyRoot

  Default Value: false

  Example:

  false

• orderBy: string
  orderBy

  Example:

  lastModifiedDate:desc

• status: string
  status

  Example:

  DRAFT

• studyId: string(uuid)
  studyId

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyVersion: string
  studyVersion

  Example:

  1.0.0.1

• tags: string
  tags

  Example:

  LIB

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Information about a library object.

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

Nested 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 LibraryPaginationResponseV2

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