REST API for Clinical One Platform

Get library kits with pagination

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
limit(required): integer(int32)

Minimum Value: 1

limit
offset(required): integer(int32)

Minimum Value: 0

offset
orderBy: string

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

The pooling ID to filter by
searchStr: string

The kit description or pooling ID string to search for
status: string

The status to filter by

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

Caller study ID - for study roles only
trialSupplyType: string

The trial supply type to filter by

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

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : LibraryKitsDtoV1 v1.0

Type: object

Title: LibraryKitsDtoV1 v1.0

Information about library kits

Show Source

kitDescription: string (string)

Kits description

Example: Placebo
libraryKitId: string (uuid)

Library kit ID
poolingId: string (string)

Pooling ID

Example: BPAF
status: string

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

Library status

Example: DRAFT
storageSetting: string

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

Kit storage setting.

Example: REFRIGERATED
trialSupplyType: string

Trial supply type for the kit.

Example: BOTTLE
unitsPerKit: number (double)

Units per Kit

Example: 5

{
    "title":"LibraryKitsDtoV1 v1.0",
    "type":"object",
    "properties":{
        "trialSupplyType":{
            "type":"string",
            "description":"Trial supply type for the kit.",
            "example":"BOTTLE"
        },
        "storageSetting":{
            "type":"string",
            "description":"Kit storage setting.",
            "example":"REFRIGERATED",
            "enum":[
                "AMBIENT",
                "REFRIGERATED",
                "FROZEN"
            ]
        },
        "libraryKitId":{
            "type":"string",
            "description":"Library kit ID",
            "format":"uuid"
        },
        "poolingId":{
            "type":"string",
            "description":"Pooling ID",
            "format":"string",
            "example":"BPAF"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kits description",
            "format":"string",
            "example":"Placebo"
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Units per Kit",
            "format":"double",
            "example":5
        },
        "status":{
            "type":"string",
            "description":"Library status",
            "example":"DRAFT",
            "enum":[
                "DRAFT",
                "APPROVED",
                "ARCHIVED",
                "PUBLISHED"
            ]
        }
    },
    "description":"Information about library kits"
}

400 Response

Bad request.

Root Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

500 Response

Error

Root Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}