Show Source

• codeName: string
• codeType: string
• comment: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• optLock: string (date-time)
• reason: string
• softwareVersionNumber: number
• userId: string (uuid)
• values: array values
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeName":{
            "type":"string"
        },
        "codeType":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeValueDto"
            }
        }
    }
}

Show Source

• Array of: object CodeValueDto

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

Show Source

• codeId: string (uuid)
• codeLabel: string
• codeValue: string
• comment: string
• id: string (uuid)
• locale: string
• objectVersionNumber: number
• operationType: string
• optLock: string (date-time)
• reason: string
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "codeId":{
            "type":"string",
            "format":"uuid"
        },
        "codeLabel":{
            "type":"string"
        },
        "codeValue":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "locale":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "optLock":{
            "type":"string",
            "format":"date-time"
        },
        "reason":{
            "type":"string",
            "writeOnly":true
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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."
}