Jump to

• Request
• Response

Get all statuses of a study

get

/ec-designer-svc/rest/v3.0/studies/{studyId}/statusessummary

Retrieves all statuses for a specified study ID.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

• versionStatus: string
  Study status filter

  Default Value:

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 StudyStatusSummaryDto v3.0
  Title: StudyStatusSummaryDto v3.0

  Summary information about a study

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

Nested Schema : StudyStatusSummaryDto v3.0

Type: object

Title: StudyStatusSummaryDto v3.0

Summary information about a study

Show Source

• companyLabels: array companyLabels
  Companies list who sponsor the study
• id: string (uuid)
  Study Unique GUID
• lastModified: string
• sourceStudyId: string (uuid)
  Study Unique GUID
• sourceStudyTitle: string (string)
  Source study title

  Example: The study
• sourceStudyVersion: string (string)
  Source study version

  Example: 1.0.0.1
• studyDescription: string
  Study description or protocol title

  Example: A randomized double blind placebo controlled study to investigate the safety of microphylla in healthy adult volunteers.
• studyState: string
  Allowed Values: [ "settings, active, design, test, training" ]

  Current study state
• studyStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Current study status

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

  Example: TICIPS001
• systemCodeListGroupName: string
  System codelist group name

  Example: Clinical One Default Code List
• version: string
  Study version

  Example: 1.0.0.3
• versionStart: string (date-time)
  Version Start date
• versionStatus: string
  Study version status

  Example: Active, not recruiting
• versionTitle: string
  Study Title or protocol number

  Example: TICIPS001:1.0.0.3

{
    "title":"StudyStatusSummaryDto v3.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.3"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001"
        },
        "studyDescription":{
            "type":"string",
            "description":"Study description or protocol title",
            "example":"A randomized double blind placebo controlled study to investigate the safety of microphylla in healthy adult volunteers."
        },
        "versionTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001:1.0.0.3"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time"
        },
        "lastModified":{
            "type":"string"
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "studyStatus":{
            "type":"string",
            "description":"Current study status",
            "example":"APPROVED",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "studyState":{
            "type":"string",
            "description":"Current study state",
            "enum":[
                "settings, active, design, test, training"
            ]
        },
        "sourceStudyId":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "sourceStudyVersion":{
            "type":"string",
            "description":"Source study version",
            "format":"string",
            "example":"1.0.0.1"
        },
        "sourceStudyTitle":{
            "type":"string",
            "description":"Source study title",
            "format":"string",
            "example":"The study"
        },
        "systemCodeListGroupName":{
            "type":"string",
            "description":"System codelist group name",
            "example":"Clinical One Default Code List"
        },
        "companyLabels":{
            "type":"array",
            "description":"Companies list who sponsor the study",
            "example":"ABC Pharma",
            "items":{
                "type":"string",
                "description":"Companies list who sponsor the study",
                "example":"ABC Pharma"
            }
        }
    },
    "description":"Summary information about a study"
}

Nested Schema : companyLabels

Type: array

Companies list who sponsor the study

Show Source

• Array of: string
  Companies list who sponsor the study

  Example: ABC Pharma

{
    "type":"array",
    "description":"Companies list who sponsor the study",
    "example":"ABC Pharma",
    "items":{
        "type":"string",
        "description":"Companies list who sponsor the study",
        "example":"ABC Pharma"
    }
}

Example:

ABC Pharma

404 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

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