Jump to

• Request
• Response

[Deprecated]: V1.0

get

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

Deprecated: Retrieves all the child items, forms and visits required to be cleared in order to modify a given data element.

Request

Path Parameters

• dataelementId(required): string(uuid)
  DataElement ID
• mode(required): string
  Mode of the study. Accepts test, active, or training.
• opeartionType(required): string
  Scope of the API is it clear/update
• studyId(required): string
  ID of the study for which you want to filter and retrieve data elements.

Query Parameters

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

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 ChildInfoDto1
  Child information flags and child items for a data element operation

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

Nested Schema : ChildInfoDto1

Type: object

Child information flags and child items for a data element operation

Show Source

• childInFuture: boolean
  True if the child item belongs to a future visit instance

  Example: false
• childIsFrozen: boolean
  True if the child item is frozen

  Example: false
• childIsHidden: boolean
  True if the child item is hidden by rule or configuration

  Example: false
• childIsLocked: boolean
  True if the child item is locked

  Example: false
• childIsReadOnly: boolean
  True if the child item is read-only

  Example: false
• childIsUnFrozen: boolean
  True if the child item is unfrozen

  Example: false
• childItems: array childItems
  List of child items derived for the requested operation
• formAssociated: boolean
  True if the item is associated with a form association

  Example: false
• isGrandParent: boolean
  True if the item is a grandparent item in hierarchy

  Example: false
• itemEligibleForClear: boolean
  Indicates if the item is eligible to be cleared

  Example: false

{
    "type":"object",
    "properties":{
        "itemEligibleForClear":{
            "type":"boolean",
            "description":"Indicates if the item is eligible to be cleared",
            "example":false
        },
        "childInFuture":{
            "type":"boolean",
            "description":"True if the child item belongs to a future visit instance",
            "example":false
        },
        "childIsHidden":{
            "type":"boolean",
            "description":"True if the child item is hidden by rule or configuration",
            "example":false
        },
        "childIsLocked":{
            "type":"boolean",
            "description":"True if the child item is locked",
            "example":false
        },
        "childIsFrozen":{
            "type":"boolean",
            "description":"True if the child item is frozen",
            "example":false
        },
        "childIsUnFrozen":{
            "type":"boolean",
            "description":"True if the child item is unfrozen",
            "example":false
        },
        "childIsReadOnly":{
            "type":"boolean",
            "description":"True if the child item is read-only",
            "example":false
        },
        "isGrandParent":{
            "type":"boolean",
            "description":"True if the item is a grandparent item in hierarchy",
            "example":false
        },
        "formAssociated":{
            "type":"boolean",
            "description":"True if the item is associated with a form association",
            "example":false
        },
        "childItems":{
            "type":"array",
            "description":"List of child items derived for the requested operation",
            "items":{
                "type":"object",
                "description":"List of child items derived for the requested operation"
            }
        }
    },
    "description":"Child information flags and child items for a data element operation"
}

Nested Schema : childItems

Type: array

List of child items derived for the requested operation

Show Source

• Array of: object items
  List of child items derived for the requested operation

{
    "type":"array",
    "description":"List of child items derived for the requested operation",
    "items":{
        "type":"object",
        "description":"List of child items derived for the requested operation"
    }
}

Nested Schema : items

Type: object

List of child items derived for the requested operation

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