Jump to

• Request
• Response

V1.0

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/kits/names

Retrieves list of kit names in a study version.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

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 KitTypeIdDto

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

Nested Schema : KitTypeIdDto

Type: object

Show Source

• id: string (uuid)
• kitEnd: string (date-time)
• kitStart: string (date-time)
• kitTypeId: string
• studyVersion: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "kitStart":{
            "type":"string",
            "format":"date-time"
        },
        "kitEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyVersion":{
            "type":"string"
        },
        "kitTypeId":{
            "type":"string"
        }
    }
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

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