Jump to

• Request
• Response

Gets a library depending on query parameters with pagination

get

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

Gets a library objects with pagination

Request

Query Parameters

• excludeStudyId: string(uuid)
  excludeStudyId
• libraryId: string(uuid)
  Library ID
• limit(required): integer(int32)
  Minimum Value: 0

  limit
• objectGroup: string
  objectGroup
• objectGroupEquals: string
  objectGroupEquals
• objectId: string(uuid)
  objectId
• objectType: string
  objectType
• offset(required): integer(int32)
  Minimum Value: 0

  offset
• onlyRoot: boolean
  onlyRoot

  Default Value: false
• orderBy: string
  orderBy
• status: string
  status
• studyId: string(uuid)
  studyId
• studyVersion: string
  studyVersion
• tags: string
  tags

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 LibraryDto v1.0
  Title: LibraryDto v1.0

  Information about library

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

Nested Schema : LibraryDto v1.0

Type: object

Title: LibraryDto v1.0

Information about library

Show Source

• description: string
  Library description

  Example: Advanced demography form
• libraryId: string (uuid)
  Library ID
• libraryVersion: string
  Library version

  Example: v1.0
• objectGroup: string
  Object group (title)

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

  Example: FORM
• status: string
  Library status

  Example: DRAFT
• studyId: string (uuid)
  Library study id
• studyVersion: string
  Library study version

  Example: 1.0.0.1
• tags: string
  Library tags

  Example: LIB

{
    "title":"LibraryDto v1.0",
    "type":"object",
    "properties":{
        "libraryId":{
            "type":"string",
            "description":"Library ID",
            "format":"uuid"
        },
        "objectId":{
            "type":"string",
            "description":"Object (forms, rules...) ID",
            "format":"uuid"
        },
        "objectType":{
            "type":"string",
            "description":"Object type",
            "example":"FORM"
        },
        "objectGroup":{
            "type":"string",
            "description":"Object group (title)",
            "example":"Demography"
        },
        "libraryVersion":{
            "type":"string",
            "description":"Library version",
            "example":"v1.0"
        },
        "status":{
            "type":"string",
            "description":"Library status",
            "example":"DRAFT"
        },
        "description":{
            "type":"string",
            "description":"Library description",
            "example":"Advanced demography form"
        },
        "tags":{
            "type":"string",
            "description":"Library tags",
            "example":"LIB"
        },
        "studyId":{
            "type":"string",
            "description":"Library study id",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Library study version",
            "example":"1.0.0.1"
        }
    },
    "description":"Information about library"
}

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