REST API for Clinical One Platform

Create multiple data elements in a form with form associations

post

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/formassociations

Creates multiple data elements in a particular form with form associations, within a visit for a given subject.
Rights: DataCaptureSubjectPost and SubjectDataClassificationPost.

Request

Path Parameters

mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study to which the subject belongs and for which you want to save the data elments and form associations.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

context: object Context3
dataElements: array dataElements
formsAssociations: array formsAssociations

{
    "type":"object",
    "properties":{
        "formsAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormAssociationsDataElmntsReqDto21"
            }
        },
        "context":{
            "$ref":"#/components/schemas/Context3"
        },
        "dataElements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreDataElementV5"
            }
        }
    }
}

Nested Schema : Context3

Type: object

Show Source

eventId: string
eventInstanceNum: integer
formId: string
innerRepeat: integer
outerRepeat: integer
repeatFormNumber: integer
repeatSequenceNumber: integer
siteId: string
studyName: string

Minimum Length: 0

Maximum Length: 100
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "studyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        }
    }
}

Nested Schema : dataElements

Type: array

Show Source

Array of: object CoreDataElementV5

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

Nested Schema : formsAssociations

Type: array

Show Source

Array of: object FormAssociationsDataElmntsReqDto21

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

Nested Schema : CoreDataElementV5

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
dataFlag: string (uuid)
dayValue: integer
floatValue: number
formSectionId: string
hdiId: string
hourValue: integer
id: string (uuid)
innerRepeat: integer
itemId: string
measureUnit: string
minuteValue: integer
monthValue: integer
numValue: integer
originatorId: string
outerRepeat: integer
propertyId: string
propertyVersionStart: string (date-time)
reason: string

Minimum Length: 0

Maximum Length: 255
repeatFormNumber: integer
repeatSequenceNumber: integer
secondValue: integer
transactionEnd: string (date-time)
transactionStart: string (date-time)
utcDateTimeValue: string (date-time)
validationFailure: string
validationStatus: string
value: string

Minimum Length: 0

Maximum Length: 4000
variableId: string
vendorCode: string

Minimum Length: 0

Maximum Length: 100
yearValue: integer

{
    "type":"object",
    "properties":{
        "utcDateTimeValue":{
            "type":"string",
            "format":"date-time"
        },
        "monthValue":{
            "type":"integer"
        },
        "dayValue":{
            "type":"integer"
        },
        "yearValue":{
            "type":"integer"
        },
        "hourValue":{
            "type":"integer"
        },
        "minuteValue":{
            "type":"integer"
        },
        "secondValue":{
            "type":"integer"
        },
        "validationStatus":{
            "type":"string"
        },
        "validationFailure":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "transactionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "variableId":{
            "type":"string"
        },
        "originatorId":{
            "type":"string"
        },
        "vendorCode":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "itemId":{
            "type":"string"
        },
        "value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "measureUnit":{
            "type":"string"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "numValue":{
            "type":"integer"
        },
        "floatValue":{
            "type":"number"
        },
        "dataFlag":{
            "type":"string",
            "format":"uuid"
        },
        "propertyId":{
            "type":"string"
        },
        "propertyVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "hdiId":{
            "type":"string"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : FormAssociationsDataElmntsReqDto21

Type: object

Show Source

associatedEventId: string
associatedEventInstanceNum: integer (int32)
associatedFormId: string
associatedFormSectionId: string
associatedRepeatFormNumber: integer
associatedRepeatSequenceNumber: integer
associatedStudyVersion: string
srcFormSectionId: string
srcItemId: string

{
    "type":"object",
    "properties":{
        "associatedEventId":{
            "type":"string"
        },
        "associatedEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedFormId":{
            "type":"string"
        },
        "associatedRepeatSequenceNumber":{
            "type":"integer"
        },
        "srcItemId":{
            "type":"string"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "srcFormSectionId":{
            "type":"string"
        },
        "associatedFormSectionId":{
            "type":"string"
        },
        "associatedRepeatFormNumber":{
            "type":"integer"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DataElementsFormAssociationsDto3

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

Nested Schema : DataElementsFormAssociationsDto3

Type: object

Show Source

dataElements: array dataElements
formsAssociations: array formsAssociations

{
    "type":"object",
    "properties":{
        "dataElements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataElementDto12"
            }
        },
        "formsAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormsAssociationsDto"
            }
        }
    }
}

Nested Schema : dataElements

Type: array

Show Source

Array of: object DataElementDto12

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

Nested Schema : formsAssociations

Type: array

Show Source

Array of: object FormsAssociationsDto

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

Nested Schema : DataElementDto12

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Comment for the data element change

Example: Captured by device
dataFlag: string (uuid)

Data flag identifier
dateTimeValueUTC: string (date-time)

Date-time value in UTC

Example: 2025-10-16T14:30:31.892Z
dayValue: integer (int32)

Day part of date

Example: 16
eventId: string

Event identifier in uppercase hex format

Example: ADF5A7800A954FA5B831E7B6B9CA39A9
eventInstanceNum: integer (int32)

Unscheduled/cycle visit instance number when applicable.

Example: 1
floatValue: number (decimal)

Numeric decimal value

Example: 12.34
formId: string

Form identifier in uppercase hex format

Example: 40DB4EF4847849CCB24EFCCB71CDA436
formSectionId: string

Form section identifier in uppercase hex format

Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
freezedStatus: string

Freeze status of the data element

Example: FROZEN
hourValue: integer (int32)

Hour part of time

Example: 14
id: string (uuid)

Unique identifier of the data element
innerRepeat: integer
itemD: string

Additional item detail D

Example: DETAIL
itemF: string

Additional item flag F

Example: FLAG
itemId: string

Item identifier in uppercase hex format

Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
itemR: string

Additional item reason R

Example: REASON
itemType: string

Type of item represented by this data element

Example: TEXT
measureUnit: string

Minimum Length: 0

Maximum Length: 64

Measurement unit

Example: mg/dL
minuteValue: integer (int32)

Minute part of time

Example: 30
monthValue: integer (int32)

Month part of date

Example: 10
normalizedUnitId: string

Identifier of normalized unit

Example: A78AD8C31CD843CD8B847C06C0420FF5
normalizedValue: string

Minimum Length: 0

Maximum Length: 100

Normalized value if applicable

Example: A78AD8C31CD843CD8B847C06C0420FF5
numValue: integer (int32)

Numeric integer value

Example: 120
objectVersionNumber: number

Object version number for optimistic locking

Example: 14
operationType: string

Operation type on the data element

Example: MODIFIED
originatorId: string

Originator identifier in uppercase hex format

Example: FEDCBA9876543210FEDCBA9876543210
outerRepeat: integer
parentId: string

Identifier of the parent data element in uppercase hex

Example: ABCDEF1234567890ABCDEF1234567890
propertyId: string

Property identifier in uppercase hex format

Example: 40DB4EF4847849CCB24EFCCB71CDA436
propertyVersionStart: string (date-time)

Timestamp when the property version started

Example: 2025-10-16T14:30:31.892Z
reason: string

Minimum Length: 0

Maximum Length: 255

Reason associated with the data element change

Example: Initial entry
repeatFormNumber: integer (int32)

Repeat form instance number for the data element

Example: 2
repeatSequenceNumber: integer (int32)

Repeat sequence number for repeating form or item

Example: 1
rootId: string

Identifier of the root data element in uppercase hex

Example: 1234567890ABCDEF1234567890ABCDEF
secondValue: integer (int32)

Second part of time

Example: 31
signedStatus: string

Signature status of the data element

Example: SIGNED
siteId: string

Site identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
softwareVersionNumber: number

Software version number associated with this data element version

Example: 14
studyId: string

Study identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
studyName: string

Minimum Length: 0

Maximum Length: 100

Study name

Example: STUDY-ABC
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100

Study version string

Example: 3.0.0.1
subjectId: string

Subject identifier in uppercase hex format

Example: 10F75668189F422F9A461A315D211111
targets: array targets

List of display or rule targets associated with this data element
transactionEnd: string (date-time)

Transaction end timestamp

Example: 2025-10-16T14:30:31.892Z
transactionStart: string (date-time)

Transaction start timestamp

Example: 2025-10-16T14:30:31.892Z
userId: string (uuid)
validationFailure: string

Minimum Length: 0

Maximum Length: 32767

Validation failure details if any

Example: Incorrect values not allowed
validationStatus: string

Minimum Length: 0

Maximum Length: 25

Validation status of the data element

Example: SUCCESS
value: string

Minimum Length: 0

Maximum Length: 4000

Raw value captured for the item

Example: 120
variableId: string

Variable identifier in uppercase hex format

Example: 0123456789ABCDEF0123456789ABCDEF
vendorCode: string

Minimum Length: 0

Maximum Length: 100

Vendor code if provided

Example: VENDOR1
verifiedStatus: string

Verification status of the data element

Example: VERIFIED
versionEnd: string (date-time)

End timestamp of the data element version

Example: 2025-10-16T14:30:31.892Z
versionStart: string (date-time)

Start timestamp of the element version

Example: 2025-10-16T14:30:31.892Z
yearValue: integer (int32)

Year part of date

Example: 2025

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the data element",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the element version",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "transactionStart":{
            "type":"string",
            "description":"Transaction start timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "transactionEnd":{
            "type":"string",
            "description":"Transaction end timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "validationStatus":{
            "maxLength":25,
            "minLength":0,
            "type":"string",
            "description":"Validation status of the data element",
            "example":"SUCCESS"
        },
        "validationFailure":{
            "maxLength":32767,
            "minLength":0,
            "type":"string",
            "description":"Validation failure details if any",
            "example":"Incorrect values not allowed"
        },
        "studyId":{
            "type":"string",
            "description":"Study identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Study name",
            "example":"STUDY-ABC"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Study version string",
            "example":"3.0.0.1"
        },
        "subjectId":{
            "type":"string",
            "description":"Subject identifier in uppercase hex format",
            "example":"10F75668189F422F9A461A315D211111"
        },
        "eventId":{
            "type":"string",
            "description":"Event identifier in uppercase hex format",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "formId":{
            "type":"string",
            "description":"Form identifier in uppercase hex format",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "formSectionId":{
            "type":"string",
            "description":"Form section identifier in uppercase hex format",
            "example":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Repeat sequence number for repeating form or item",
            "format":"int32",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Item identifier in uppercase hex format",
            "example":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF"
        },
        "siteId":{
            "type":"string",
            "description":"Site identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "variableId":{
            "type":"string",
            "description":"Variable identifier in uppercase hex format",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "originatorId":{
            "type":"string",
            "description":"Originator identifier in uppercase hex format",
            "example":"FEDCBA9876543210FEDCBA9876543210"
        },
        "vendorCode":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Vendor code if provided",
            "example":"VENDOR1"
        },
        "value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Raw value captured for the item",
            "example":"120"
        },
        "measureUnit":{
            "maxLength":64,
            "minLength":0,
            "type":"string",
            "description":"Measurement unit",
            "example":"mg/dL"
        },
        "normalizedValue":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Normalized value if applicable",
            "example":"A78AD8C31CD843CD8B847C06C0420FF5"
        },
        "normalizedUnitId":{
            "type":"string",
            "description":"Identifier of normalized unit",
            "example":"A78AD8C31CD843CD8B847C06C0420FF5"
        },
        "numValue":{
            "type":"integer",
            "description":"Numeric integer value",
            "format":"int32",
            "example":120
        },
        "floatValue":{
            "type":"number",
            "description":"Numeric decimal value",
            "format":"decimal",
            "example":12.34
        },
        "dateTimeValueUTC":{
            "type":"string",
            "description":"Date-time value in UTC",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "monthValue":{
            "type":"integer",
            "description":"Month part of date",
            "format":"int32",
            "example":10
        },
        "dayValue":{
            "type":"integer",
            "description":"Day part of date",
            "format":"int32",
            "example":16
        },
        "yearValue":{
            "type":"integer",
            "description":"Year part of date",
            "format":"int32",
            "example":2025
        },
        "hourValue":{
            "type":"integer",
            "description":"Hour part of time",
            "format":"int32",
            "example":14
        },
        "minuteValue":{
            "type":"integer",
            "description":"Minute part of time",
            "format":"int32",
            "example":30
        },
        "secondValue":{
            "type":"integer",
            "description":"Second part of time",
            "format":"int32",
            "example":31
        },
        "parentId":{
            "type":"string",
            "description":"Identifier of the parent data element in uppercase hex",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "rootId":{
            "type":"string",
            "description":"Identifier of the root data element in uppercase hex",
            "example":"1234567890ABCDEF1234567890ABCDEF"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the data element change",
            "example":"Initial entry"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for the data element change",
            "example":"Captured by device"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the data element",
            "example":"MODIFIED"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number for optimistic locking",
            "example":14
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number associated with this data element version",
            "example":14
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Unscheduled/cycle visit instance number when applicable.",
            "format":"int32",
            "example":1
        },
        "targets":{
            "type":"array",
            "description":"List of display or rule targets associated with this data element",
            "example":[
                "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
                "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
            ],
            "items":{
                "type":"string",
                "description":"List of display or rule targets associated with this data element",
                "example":"[\"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5\",\"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7\"]"
            }
        },
        "dataFlag":{
            "type":"string",
            "description":"Data flag identifier",
            "format":"uuid"
        },
        "signedStatus":{
            "type":"string",
            "description":"Signature status of the data element",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verification status of the data element",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Freeze status of the data element",
            "example":"FROZEN"
        },
        "propertyId":{
            "type":"string",
            "description":"Property identifier in uppercase hex format",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "propertyVersionStart":{
            "type":"string",
            "description":"Timestamp when the property version started",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"End timestamp of the data element version",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "itemType":{
            "type":"string",
            "description":"Type of item represented by this data element",
            "example":"TEXT"
        },
        "itemD":{
            "type":"string",
            "description":"Additional item detail D",
            "example":"DETAIL"
        },
        "itemF":{
            "type":"string",
            "description":"Additional item flag F",
            "example":"FLAG"
        },
        "itemR":{
            "type":"string",
            "description":"Additional item reason R",
            "example":"REASON"
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Repeat form instance number for the data element",
            "format":"int32",
            "example":2
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        }
    }
}

Nested Schema : targets

Type: array

List of display or rule targets associated with this data element

Show Source

Array of: string

List of display or rule targets associated with this data element

Example: ["93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5","93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"]

{
    "type":"array",
    "description":"List of display or rule targets associated with this data element",
    "example":[
        "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
        "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
    ],
    "items":{
        "type":"string",
        "description":"List of display or rule targets associated with this data element",
        "example":"[\"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5\",\"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7\"]"
    }
}

Example:

[
    "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
    "93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
]

Nested Schema : FormsAssociationsDto

Type: object

Show Source

associatedEventId: string
associatedEventInstanceNum: integer (int32)
associatedFormId: string
associatedRepeatSequenceNumber: integer
associatedStudyVersion: string
comment: string
id: string (uuid)
objectVersionNumber: number
reason: string
siteId: string
srcEventId: string
srcEventInstanceNum: integer (int32)
srcFormId: string
srcItemId: string
srcRepeatSequenceNumber: integer
srcStudyVersion: string
subjectId: string
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "subjectId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "srcEventId":{
            "type":"string"
        },
        "srcEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "srcFormId":{
            "type":"string"
        },
        "srcRepeatSequenceNumber":{
            "type":"integer"
        },
        "srcStudyVersion":{
            "type":"string"
        },
        "associatedEventId":{
            "type":"string"
        },
        "associatedEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedFormId":{
            "type":"string"
        },
        "associatedRepeatSequenceNumber":{
            "type":"integer"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "srcItemId":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object