Jump to

• Request
• Response

[Deprecated]: Get a list of all studies

get

/ec-designer-svc/rest/v1.0/studies

Deprecated: Use latest version instead. Retrieves a list of the latest studies in your system.

Request

There are no request parameters for this operation.

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

  Information about a study for UI consumption.

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

Nested Schema : StudyDto v1.0

Type: object

Title: StudyDto v1.0

Information about a study for UI consumption.

Show Source

• approvedVersionsCount: integer (int32)
  Count of study in approved mode

  Example: 1
• archivedVersionsCount: integer (int32)
  Count of study in archived mode

  Example: 1
• contractCode: string
  Study contract code or identifier

  Example: NCT00000419
• customerRefNo: string
  Customer reference number
• description: string
  Study description
• draftVersionsCount: integer (int32)
  Count of study in draft mode

  Example: 1
• everApprovedCount: integer (int32)
  If study was ever approved

  Example: 1
• hasObjects: integer (int32)
  If study contains any artifacts

  Example: 1
• id: string (uuid)
  Study Unique GUID
• identity: string
  Study identity - concatenation of study id and version

  Example: 8C4ECDFD9C214D38B4E68D3107BA0AF9:1.0.0.3
• modes: array modes
• openLabelBlinded: string
  Study type for open label and blinded

  Example: DoubleBlinded
• singleKitSettingId: string
  Single kit id
• sowNo: string
  SOW number
• sponsorId: string
  Sponsor Id
• 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.
• studyPhase: string
  Study phase

  Example: II
• studyStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Current study status

  Example: APPROVED
• studyStatusId: integer (int32)
  Study status Id
• studyTitle: string
  Study Title or protocol number

  Example: TICIPS001
• testingVersionsCount: integer (int32)
  Count of study in testing mode

  Example: 1
• therapeuticArea: string
  Study therapeutic area

  Example: Infectious Diseases
• useBlindingGroups: boolean
  Whether study uses blinding groups
• useLabelGroups: boolean
  Whether study uses label groups
• useShippinggroups: boolean
  Whether study uses shipping groups
• version: string
  Study version

  Example: 1.0.0.3
• versionEnd: string (date-time)
  Version End

  Example: 3099-12-31T05:00:00Z
• versionPreviousStatus: string
  Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

  Previous study status

  Example: TESTING
• 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
• versionType: string
  Study version type

  Example: Active, not recruiting

{
    "title":"StudyDto v1.0",
    "type":"object",
    "properties":{
        "identity":{
            "type":"string",
            "description":"Study identity - concatenation of study id and version",
            "example":"8C4ECDFD9C214D38B4E68D3107BA0AF9:1.0.0.3"
        },
        "id":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.3"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time",
            "example":"3099-12-31T05:00:00Z"
        },
        "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."
        },
        "contractCode":{
            "type":"string",
            "description":"Study contract code or identifier",
            "example":"NCT00000419"
        },
        "versionTitle":{
            "type":"string",
            "description":"Study Title or protocol number",
            "example":"TICIPS001:1.0.0.3"
        },
        "studyPhase":{
            "type":"string",
            "description":"Study phase",
            "example":"II"
        },
        "therapeuticArea":{
            "type":"string",
            "description":"Study therapeutic area",
            "example":"Infectious Diseases"
        },
        "openLabelBlinded":{
            "type":"string",
            "description":"Study type for open label and blinded",
            "example":"DoubleBlinded"
        },
        "studyStatus":{
            "type":"string",
            "description":"Current study status",
            "example":"APPROVED",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionType":{
            "type":"string",
            "description":"Study version type",
            "example":"Active, not recruiting"
        },
        "hasObjects":{
            "type":"integer",
            "description":"If study contains any artifacts",
            "format":"int32",
            "example":"1"
        },
        "draftVersionsCount":{
            "type":"integer",
            "description":"Count of study in draft mode",
            "format":"int32",
            "example":"1"
        },
        "testingVersionsCount":{
            "type":"integer",
            "description":"Count of study in testing mode",
            "format":"int32",
            "example":"1"
        },
        "approvedVersionsCount":{
            "type":"integer",
            "description":"Count of study in approved mode",
            "format":"int32",
            "example":"1"
        },
        "archivedVersionsCount":{
            "type":"integer",
            "description":"Count of study in archived mode",
            "format":"int32",
            "example":"1"
        },
        "everApprovedCount":{
            "type":"integer",
            "description":"If study was ever approved",
            "format":"int32",
            "example":"1"
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Study modes",
                "example":"active",
                "enum":[
                    "test",
                    "training",
                    "active"
                ]
            }
        },
        "customerRefNo":{
            "type":"string",
            "description":"Customer reference number"
        },
        "description":{
            "type":"string",
            "description":"Study description"
        },
        "singleKitSettingId":{
            "type":"string",
            "description":"Single kit id"
        },
        "sowNo":{
            "type":"string",
            "description":"SOW number"
        },
        "sponsorId":{
            "type":"string",
            "description":"Sponsor Id"
        },
        "studyStatusId":{
            "type":"integer",
            "description":"Study status Id",
            "format":"int32"
        },
        "useBlindingGroups":{
            "type":"boolean",
            "description":"Whether study uses blinding groups"
        },
        "useLabelGroups":{
            "type":"boolean",
            "description":"Whether study uses label groups"
        },
        "useShippinggroups":{
            "type":"boolean",
            "description":"Whether study uses shipping groups"
        }
    },
    "description":"Information about a study for UI consumption."
}

Nested Schema : modes

Type: array

Show Source

• Array of: string
  Allowed Values: [ "test", "training", "active" ]

  Study modes

  Example: active

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Study modes",
        "example":"active",
        "enum":[
            "test",
            "training",
            "active"
        ]
    }
}

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