Jump to

• Request
• Response

Get summary of library studies usage

get

/ec-designer-svc/rest/v2.0/studies/library/{libraryId}/studyType/{studyType}/studyUses

Retrieves all usage for library studies including info if some of the copies was modified

Request

Path Parameters

• libraryId(required): string(uuid)
  Library ID. Example: 9BE2FB6177DF426389C36FD61E1DDF7F
• studyType(required): string
  Study type. Example: LIBRARY

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

  Summary information about which study is reused together with all necesayr info, for example modified after copy

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

Nested Schema : StudyLibraryObjectUseDto v1.0

Type: object

Title: StudyLibraryObjectUseDto v1.0

Summary information about which study is reused together with all necesayr info, for example modified after copy

Show Source

• id: string (uuid)
  Study Unique GUID
• modifiedAfterCopy: boolean (number)
  1 for true, 0 for false

  Example: false
• studyTitle: string
  Study Title or protocol number

  Example: TICIPS001
• versionStart: string (date-time)
  Study approval date

  Example: 2020-07-26T14:24:52.346Z

{
    "title":"StudyLibraryObjectUseDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001"
        },
        "modifiedAfterCopy":{
            "type":"boolean",
            "description":"1 for true, 0 for false",
            "format":"number",
            "example":false
        },
        "versionStart":{
            "type":"string",
            "description":"Study approval date",
            "format":"date-time",
            "example":"2020-07-26T14:24:52.346Z"
        }
    },
    "description":"Summary information about which study is reused together with all necesayr info, for example modified after copy"
}

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