Jump to

• Request
• Response

V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/subjects/{subjectId}/events/{eventId}/dynamic-items/visibility

Returns item visibility for requested items using Designer dynamic item metadata and active DCS subject data.

Request

Path Parameters

• eventId(required): string(uuid)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  53915DD9B758466AB2226CBCC4466B7E

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study for which you want to filter and retrieve data elements.
• studyVersion(required): string
  String representing the version of the study. Helps track changes in form or study design.

  Example:

  3.0.0.1

• subjectId(required): string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  B5969AC2FBA840438F9E0DB26A2DD33E

Query Parameters

• eventInstanceNum: integer(int64)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• forms: array forms

{
    "type":"object",
    "properties":{
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DynamicItemVisibilityFormRequestDto"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

• Array of: object DynamicItemVisibilityFormRequestDto

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

Nested Schema : DynamicItemVisibilityFormRequestDto

Type: object

Show Source

• formId: string
• itemIds: array itemIds

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string"
        },
        "itemIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : itemIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example DynamicItemVisibilityRequestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : DynamicItemVisibilityResponseDto

Type: object

Show Source

• forms: array forms

{
    "type":"object",
    "properties":{
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DynamicItemVisibilityFormResponseDto"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

• Array of: object DynamicItemVisibilityFormResponseDto

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

Nested Schema : DynamicItemVisibilityFormResponseDto

Type: object

Show Source

• formId: string
• items: array items

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DynamicItemVisibilityItemResponseDto"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DynamicItemVisibilityItemResponseDto

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

Nested Schema : DynamicItemVisibilityItemResponseDto

Type: object

Show Source

• innerRepeat: integer
• itemId: string
• outerRepeat: integer
• visible: boolean

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "visible":{
            "type":"boolean"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested 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 : result

Type: object

Nested Schema : details

Type: object

Back to Top