Show Source

• sdfKitSettings: array sdfKitSettings

{
    "type":"object",
    "properties":{
        "sdfKitSettings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFKitSettingDto"
            }
        }
    }
}

Show Source

• Array of: object SDFKitSettingDto

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

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• kitTypeId(required): string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• settingName(required): string
• settingOperationType: string
• settingValue(required): string
• versionStart: string (date-time)

{
    "required":[
        "kitTypeId",
        "settingName",
        "settingValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "settingName":{
            "type":"string"
        },
        "settingValue":{
            "type":"string"
        },
        "settingOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

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