Jump to

• Request
• Response

V1.0

get

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

Retrieves all the forms of the latest study version of other studies.

Request

Path Parameters

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

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

Query Parameters

• otherStudy(required): string
  OtherStudy, which can have the value all, or otherStudy ID. It defaults to value first in the absence of query param.

  Default Value: first

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : AllStudiesFormsDto v1.0

Type: object

Title: AllStudiesFormsDto v1.0

Information about all the forms of latest study version of all other studies for UI consumption.

Show Source

• otherStudies: object otherStudies
  Additional Properties Allowed: additionalProperties

  Other studies the user is assigned to
• studyForms: array studyForms
  All Forms

{
    "title":"AllStudiesFormsDto v1.0",
    "type":"object",
    "properties":{
        "otherStudies":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "description":"Other studies the user is assigned to"
            },
            "description":"Other studies the user is assigned to"
        },
        "studyForms":{
            "type":"array",
            "description":"All Forms",
            "items":{
                "$ref":"#/components/schemas/StudyFormDtoV1"
            }
        }
    },
    "description":"Information about all the forms of latest study version of all other studies for UI consumption."
}

Nested Schema : otherStudies

Type: object

Additional Properties Allowed

Show Source

• string
  Other studies the user is assigned to

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "description":"Other studies the user is assigned to"
    },
    "description":"Other studies the user is assigned to"
}

Other studies the user is assigned to

Nested Schema : studyForms

Type: array

All Forms

Show Source

• Array of: object StudyFormDto v1.0
  Title: StudyFormDto v1.0

  Study Form Info of latest study version of other studies

{
    "type":"array",
    "description":"All Forms",
    "items":{
        "$ref":"#/components/schemas/StudyFormDtoV1"
    }
}

Nested Schema : StudyFormDto v1.0

Type: object

Title: StudyFormDto v1.0

Study Form Info of latest study version of other studies

Show Source

• fields: integer (int32)
  fields count of the form

  Example: 3
• formId: string (uuid)
  Form Unique GUID
• refname: string
  Form refname

  Example: FORM_01
• 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.
• studyId: string (uuid)
  Study Unique GUID
• studyTitle: string
  Study Title or protocol number

  Example: TICIPS001
• studyVersion: string
  Study version

  Example: 1.0.0.3
• therapeuticArea: string
  Study therapeutic area

  Example: Infectious Diseases
• title: string
  Form title

  Example: Demography

{
    "title":"StudyFormDto v1.0",
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "description":"Study Unique GUID",
            "format":"uuid"
        },
        "studyVersion":{
            "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."
        },
        "therapeuticArea":{
            "type":"string",
            "description":"Study therapeutic area",
            "example":"Infectious Diseases"
        },
        "formId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "refname":{
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "fields":{
            "type":"integer",
            "description":"fields count of the form",
            "format":"int32",
            "example":3
        }
    },
    "description":"Study Form Info of latest study version of other studies"
}

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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top