Jump to

• Request
• Response

V2.0

get

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/{dataelementId}/{opeartionType}/childItems

Retrieves all the child items, forms and visits required to be cleared in order to modify a given data element. The response also contains the eventInstanceNum fields of the child item.

Request

Path Parameters

• dataelementId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying data element.

  Example:

  906F37FB48E3421D899E1EBF885FF959

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  active

• opeartionType(required): string
  Scope of the API is it clear/update

  Example:

  clear

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  9FCBB303F8D24A3FB7DABCACF7600629

Query Parameters

• value: array[string]
  Values of the data element getting passed.

  Example:

  [
      "value1",
      "value2"
  ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ChildItemDto2
  Extended child item metadata with event instance number

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

Nested Schema : ChildItemDto2

Type: object

Extended child item metadata with event instance number

Show Source

• branchVisit: boolean
  Indicates if the item belongs to a branch visit

  Example: false
• eventId: string
  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: 0123456789ABCDEF0123456789ABCDEF
• eventInstanceNum: integer (int32)
  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
• formId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 0123456789ABCDEF0123456789ABCDEF
• inFuture: boolean
  Whether the item belongs to a future visit instance

  Example: false
• isHidden: boolean
  Whether the item is hidden by rule or configuration

  Example: false
• isReadOnly: boolean
  Whether the item is read-only

  Example: false
• itemId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.

  Example: 0123456789ABCDEF0123456789ABCDEF
• title: string
  Display title of the child item

  Example: Height
• type: string
  Type/category of the child item (e.g., Question, Section)

  Example: Question
• visitTitle: string
  Title of the visit containing this item

  Example: Screening

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "eventId":{
            "type":"string",
            "description":"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":"0123456789ABCDEF0123456789ABCDEF"
        },
        "type":{
            "type":"string",
            "description":"Type/category of the child item (e.g., Question, Section)",
            "example":"Question"
        },
        "title":{
            "type":"string",
            "description":"Display title of the child item",
            "example":"Height"
        },
        "branchVisit":{
            "type":"boolean",
            "description":"Indicates if the item belongs to a branch visit",
            "example":false
        },
        "visitTitle":{
            "type":"string",
            "description":"Title of the visit containing this item",
            "example":"Screening"
        },
        "inFuture":{
            "type":"boolean",
            "description":"Whether the item belongs to a future visit instance",
            "example":false
        },
        "isHidden":{
            "type":"boolean",
            "description":"Whether the item is hidden by rule or configuration",
            "example":false
        },
        "isReadOnly":{
            "type":"boolean",
            "description":"Whether the item is read-only",
            "example":false
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Extended child item metadata with event instance number"
}

Examples

Select an example ChildItemsV2

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

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

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top