Jump to

• Request
• Response

V1.0

get

/ec-designer-svc/rest/v1.0/studies/{studyId}/codelist/{codeListId}/linkedformsummary

Retrieves the forms and questions that use the specified code list as a dynamic linked code list in a study. Each item identifies the form reference code and question text for a linked form item.

Request

Path Parameters

• codeListId(required): string
  Code list ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  7A4D3C2B1E8F4D56A23C9F3A0C7D4E22

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

  Example:

  2F9A6C7E1B8F4D56A23C9F3A0C7D4E11

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.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 : schema

Type: array

Show Source

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

  Summary of a form item that is linked to a dynamic code list in v1.0.

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

Nested Schema : CodeListFormitemLinkedDto v1.0

Type: object

Title: CodeListFormitemLinkedDto v1.0

Summary of a form item that is linked to a dynamic code list in v1.0.

Show Source

• formRefCode: string
  Reference code of the form that contains the linked question.

  Example: DEMOGRAPHICS
• question: string
  Question text for the form item that uses the dynamic code list.

  Example: What is the subject's date of birth?

{
    "title":"CodeListFormitemLinkedDto v1.0",
    "type":"object",
    "properties":{
        "formRefCode":{
            "type":"string",
            "description":"Reference code of the form that contains the linked question.",
            "example":"DEMOGRAPHICS"
        },
        "question":{
            "type":"string",
            "description":"Question text for the form item that uses the dynamic code list.",
            "example":"What is the subject's date of birth?"
        }
    },
    "description":"Summary of a form item that is linked to a dynamic code list in v1.0.",
    "example":{
        "formRefCode":"DEMOGRAPHICS",
        "question":"What is the subject's date of birth?"
    }
}

Example:

{
    "formRefCode":"DEMOGRAPHICS",
    "question":"What is the subject's date of birth?"
}

Examples

Select an example successResponse

400 Response

Returned when studyId or codeListId is missing or is not a valid UUID, 32-character uppercase hexadecimal string.

Body ()

Root Schema : schema

Type: string

Examples

Select an example badRequest

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top