Jump to

• Request
• Response

v1.0

get

/ec-library-svc/rest/v1.0/libraryObjects/kits/pagination

Retrieves the list of library kits with pagination.

Request

Query Parameters

• kitDescription: string
  The description to filter by

  Example:

  Placebo

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

  limit

  Example:

  50

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

  offset

  Example:

  0

• orderBy: string
  Colon separated field and sort order pair, eg. 'kitDescription:asc' or 'poolingId:desc'

  Example:

  lastModifiedDate:desc

• poolingId: string
  The pooling ID to filter by

  Example:

  BPAF

• searchStr: string
  The kit description or pooling ID string to search for

  Example:

  placebo

• status: string
  The status to filter by

  Allowed Values: [ "DRAFT", "APPROVED", "PUBLISHED", "ARCHIVED" ]

  Example:

  draft

• studyId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) caller study ID - for study roles only

  Example:

  B1B8327AFAA6412287106192AB5984EF

• trialSupplyType: string
  The trial supply type to filter by

  Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

  Example:

  INHALER

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : LibraryKitsDtoV1.0

Type: object

Title: LibraryKitsDtoV1.0

Information about library kits.

Show Source

• kitDescription: string (string)
  Title: Kit description

  Description of the kit.

  Example: Placebo
• libraryKitId: string
  Title: Library kit ID

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

  Example: B1B8327AFAA6412287106192AB5984EF
• poolingId: string (string)
  Title: Pooling ID

  Pooling identifier for the kit.

  Example: BPAF
• status: string
  Title: Status

  Allowed Values: [ "DRAFT", "APPROVED", "ARCHIVED", "PUBLISHED" ]

  Status of the resource.

  Example: DRAFT
• storageSetting: string
  Title: Storage setting

  Allowed Values: [ "AMBIENT", "REFRIGERATED", "FROZEN" ]

  Storage setting of the kit.

  Example: REFRIGERATED
• trialSupplyType: string
  Title: Trial supply type

  Trial supply type of the kit.

  Example: BOTTLE
• unitsPerKit: number (double)
  Title: Units per kit

  Number of units per kit.

  Example: 5

{
    "title":"LibraryKitsDtoV1.0",
    "type":"object",
    "properties":{
        "trialSupplyType":{
            "title":"Trial supply type",
            "type":"string",
            "description":"Trial supply type of the kit.",
            "example":"BOTTLE"
        },
        "storageSetting":{
            "title":"Storage setting",
            "type":"string",
            "description":"Storage setting of the kit.",
            "example":"REFRIGERATED",
            "enum":[
                "AMBIENT",
                "REFRIGERATED",
                "FROZEN"
            ]
        },
        "libraryKitId":{
            "title":"Library kit ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library kit.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "poolingId":{
            "title":"Pooling ID",
            "type":"string",
            "description":"Pooling identifier for the kit.",
            "format":"string",
            "example":"BPAF"
        },
        "kitDescription":{
            "title":"Kit description",
            "type":"string",
            "description":"Description of the kit.",
            "format":"string",
            "example":"Placebo"
        },
        "unitsPerKit":{
            "title":"Units per kit",
            "type":"number",
            "description":"Number of units per kit.",
            "format":"double",
            "example":5
        },
        "status":{
            "title":"Status",
            "type":"string",
            "description":"Status of the resource.",
            "example":"DRAFT",
            "enum":[
                "DRAFT",
                "APPROVED",
                "ARCHIVED",
                "PUBLISHED"
            ]
        }
    },
    "description":"Information about library kits."
}

Examples

Select an example LibraryKitsPaginationResponseV1

400 Response

Bad request.

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

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