Jump to

• Request
• Response

Clear data elements scope by study ID and mode

put

/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/clear/{scope}

Clears the scope of data elements by study ID and mode. Scope can be:

• VSD, to clear visit start date.
• ITEM, to clear a specific item.

Up-versioned to add formsStatus field to the response.

Request

Path Parameters

• scope(required): string
  Scope of the item

Query Parameters

• isDgCall: boolean
  If the call is from Digital Gateway / Digital Gateway Builder, isDgCall set to true, Cleardynamics won't be supported.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• subjectId: string (uuid)
• visits: array visits

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreClearVisitRequestDto"
            }
        }
    }
}

Nested Schema : visits

Type: array

Show Source

• Array of: object CoreClearVisitRequestDto

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

Nested Schema : CoreClearVisitRequestDto

Type: object

Show Source

• eventId: string (uuid)
• eventInstanceNumber: integer
• forms: array forms
• studyVersion: string
• visitStartDateId: string (uuid)

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNumber":{
            "type":"integer"
        },
        "studyVersion":{
            "type":"string"
        },
        "visitStartDateId":{
            "type":"string",
            "format":"uuid"
        },
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreClearFormsRequestDto"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

• Array of: object CoreClearFormsRequestDto

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

Nested Schema : CoreClearFormsRequestDto

Type: object

Show Source

• formId: string (uuid)
• formSectionId: string (uuid)
• innerRepeat: integer
• itemId: string (uuid)
• outerRepeat: integer
• repeatFormNumber: integer
• repeatSequenceNumber: integer

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "formSectionId":{
            "type":"string",
            "format":"uuid"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DataElementDto

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

Nested Schema : DataElementDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• dateTimeValueUTC: string (date-time)
• dayValue: integer
• eventId: string
• floatValue: number
• formId: string
• formSectionId: string
• hourValue: integer
• id: string (uuid)
• itemId: string
• measureUnit: string
  Minimum Length: 0

  Maximum Length: 64
• minuteValue: integer
• monthValue: integer
• normalizedUnitId: string
• normalizedValue: string
  Minimum Length: 0

  Maximum Length: 100
• numValue: integer
• originatorId: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• repeatSequenceNumber: integer
• secondValue: integer
• siteId: string
• studyId: string
• studyName: string
  Minimum Length: 0

  Maximum Length: 100
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100
• subjectId: string
• transactionEnd: string (date-time)
• transactionStart: string (date-time)
• userId: string (uuid)
• validationFailure: string
  Minimum Length: 0

  Maximum Length: 32767
• validationStatus: string
  Minimum Length: 0

  Maximum Length: 25
• value: string
  Minimum Length: 0

  Maximum Length: 4000
• variableId: string
• vendorCode: string
  Minimum Length: 0

  Maximum Length: 100
• versionStart: string (date-time)
• yearValue: integer

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "maxLength":25,
            "minLength":0,
            "type":"string"
        },
        "validationFailure":{
            "maxLength":32767,
            "minLength":0,
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "studyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "variableId":{
            "type":"string"
        },
        "originatorId":{
            "type":"string"
        },
        "vendorCode":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "measureUnit":{
            "maxLength":64,
            "minLength":0,
            "type":"string"
        },
        "normalizedValue":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "normalizedUnitId":{
            "type":"string"
        },
        "numValue":{
            "type":"integer"
        },
        "floatValue":{
            "type":"number"
        },
        "dateTimeValueUTC":{
            "type":"string",
            "format":"date-time"
        },
        "monthValue":{
            "type":"integer"
        },
        "dayValue":{
            "type":"integer"
        },
        "yearValue":{
            "type":"integer"
        },
        "hourValue":{
            "type":"integer"
        },
        "minuteValue":{
            "type":"integer"
        },
        "secondValue":{
            "type":"integer"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        }
    }
}

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