REST API for Clinical One Platform

Get kits from all study versions in Testing, Approved and Archived

get

/ec-designer-ors-svc/rest/v7.0/studies/{studyId}/kits

Retrieves list of kits for all study versions in Testing, Approved and Archived states.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

excludeKitType: string

Kit type, such as standard, titration, device or all, to filter by.

Default Value: false

Allowed Values: [ "true", "false" ]
kitType: string

Kit type, such as standard, titration, device or all, to filter by.

Default Value: all

Allowed Values: [ "standard", "device", "titration", "advancedDispensation", "all" ]
mode(required): string

Study version mode to filter kits or titration

Allowed Values: [ "test", "training", "active" ]
unblinded: boolean

Indicates if to unblind all fields for user with OrsUnblinded right.

Default Value: false

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object KitDescDto V6.0

Title: KitDescDto V6.0

Kit description and distribution setting

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

Nested Schema : KitDescDto V6.0

Type: object

Title: KitDescDto V6.0

Kit description and distribution setting

Show Source

deviceConn: string

Device Connection

Example: D2C
deviceType: string

Device Type

Example: SCALE
distributionSetting: string (string)

Distribution Setting

Example: UNBLINDED
kitDescription: string (string)

Kit description

Example: Kit_1003_1
kitId: string (uuid)

Kit Unique GUID
kitType: string (string)

Kit Type ID

Example: Kit_1003_1
libraryKitId: string (uuid)

Library Kit GUID
poolingId: string

Pooling Kit ID

Example: POL12
serialized: boolean

Is kit serialized?

Example: true
titrationKit: string

Indicates if this is a titration
trialSupplyType: string

Trial Supply Type

Example: BOTTLE

{
    "title":"KitDescDto V6.0",
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "description":"Kit Unique GUID",
            "format":"uuid"
        },
        "kitType":{
            "type":"string",
            "description":"Kit Type ID",
            "format":"string",
            "example":"Kit_1003_1"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "format":"string",
            "example":"Kit_1003_1"
        },
        "distributionSetting":{
            "type":"string",
            "description":"Distribution Setting",
            "format":"string",
            "example":"UNBLINDED"
        },
        "deviceType":{
            "type":"string",
            "description":"Device Type",
            "example":"SCALE"
        },
        "deviceConn":{
            "type":"string",
            "description":"Device Connection",
            "example":"D2C"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "titrationKit":{
            "type":"string",
            "description":"Indicates if this is a titration"
        },
        "libraryKitId":{
            "type":"string",
            "description":"Library Kit GUID",
            "format":"uuid"
        },
        "poolingId":{
            "type":"string",
            "description":"Pooling Kit ID",
            "example":"POL12"
        },
        "serialized":{
            "type":"boolean",
            "description":"Is kit serialized?",
            "example":true
        }
    },
    "description":"Kit description and distribution setting"
}

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."
}