Oracle Utilities REST API for Work and Asset

Create or Update Leave

put

https://server:port/rest/apis/asset/resources/leave/{externalId}

This REST web service synchronizes Enterprise Resource Planning (ERP) - Human Capital Management (HCM) Absence with a Work and Asset Management Employee Unavailability. This web service creates WAM Employee Unavailability creates new or updates existing records.

Request

Path Parameters

externalId(required): string
A unique identifier of the leave record as represented in the external system - Human Capital Management
Example:
```
300000230453798
```

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

input: object input
output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Work and Asset Management code that represents the external system.",
                    "example":"HCM"
                },
                "externalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "leaveType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Indicates the type of leave/unavailability for the employee",
                    "example":"i.e. Vacation"
                },
                "description":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Short description",
                    "example":"Casual Leave 5"
                },
                "applicantId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Unique identification for the employee for integration with external systems."
                },
                "applicantExternalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
                    "example":"Approved"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Indicates the start date/time period for the unavailability.",
                    "example":"12-25-2018 04:00PM"
                },
                "endDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Indicates the end date/ time period for the unavailability.",
                    "example":"12-31-2018 03:59PM"
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "leaveId":{
                    "type":"string",
                    "description":"(leaveId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

applicantExternalId: string

Maximum Length: 60

Identifier Value
applicantId: string

Maximum Length: 12

Unique identification for the employee for integration with external systems.
description: string

Maximum Length: 100

Short description

Example: Casual Leave 5
endDateTime: string (date-time)

Indicates the end date/ time period for the unavailability.

Example: 12-31-2018 03:59PM
externalId: string

Maximum Length: 60

Identifier Value
externalSystem: string

Maximum Length: 30

The Work and Asset Management code that represents the external system.

Example: HCM
leaveType: string

Maximum Length: 30

Indicates the type of leave/unavailability for the employee

Example: i.e. Vacation
startDateTime: string (date-time)

Indicates the start date/time period for the unavailability.

Example: 12-25-2018 04:00PM
status: string

Maximum Length: 12

Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected

Example: Approved

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"The Work and Asset Management code that represents the external system.",
            "example":"HCM"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "leaveType":{
            "type":"string",
            "maxLength":30,
            "description":"Indicates the type of leave/unavailability for the employee",
            "example":"i.e. Vacation"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description",
            "example":"Casual Leave 5"
        },
        "applicantId":{
            "type":"string",
            "maxLength":12,
            "description":"Unique identification for the employee for integration with external systems."
        },
        "applicantExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
            "example":"Approved"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Indicates the start date/time period for the unavailability.",
            "example":"12-25-2018 04:00PM"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Indicates the end date/ time period for the unavailability.",
            "example":"12-31-2018 03:59PM"
        }
    }
}

Nested Schema : output

Type: object

Show Source

leaveId: string

(leaveId)

{
    "type":"object",
    "properties":{
        "leaveId":{
            "type":"string",
            "description":"(leaveId)"
        }
    }
}

Root Schema : schema

Type: object

Show Source

W1UpdLeave: object schema

{
    "type":"object",
    "properties":{
        "W1UpdLeave":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "externalSystem":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The Work and Asset Management code that represents the external system.",
                            "example":"HCM"
                        },
                        "externalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "leaveType":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Indicates the type of leave/unavailability for the employee",
                            "example":"i.e. Vacation"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":100,
                            "description":"Short description",
                            "example":"Casual Leave 5"
                        },
                        "applicantId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Unique identification for the employee for integration with external systems."
                        },
                        "applicantExternalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "status":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
                            "example":"Approved"
                        },
                        "startDateTime":{
                            "type":"string",
                            "format":"date-time",
                            "description":"Indicates the start date/time period for the unavailability.",
                            "example":"12-25-2018 04:00PM"
                        },
                        "endDateTime":{
                            "type":"string",
                            "format":"date-time",
                            "description":"Indicates the end date/ time period for the unavailability.",
                            "example":"12-31-2018 03:59PM"
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "leaveId":{
                            "type":"string",
                            "description":"(leaveId)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

input: object input
output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Work and Asset Management code that represents the external system.",
                    "example":"HCM"
                },
                "externalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "leaveType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Indicates the type of leave/unavailability for the employee",
                    "example":"i.e. Vacation"
                },
                "description":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Short description",
                    "example":"Casual Leave 5"
                },
                "applicantId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Unique identification for the employee for integration with external systems."
                },
                "applicantExternalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
                    "example":"Approved"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Indicates the start date/time period for the unavailability.",
                    "example":"12-25-2018 04:00PM"
                },
                "endDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Indicates the end date/ time period for the unavailability.",
                    "example":"12-31-2018 03:59PM"
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "leaveId":{
                    "type":"string",
                    "description":"(leaveId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

applicantExternalId: string

Maximum Length: 60

Identifier Value
applicantId: string

Maximum Length: 12

Unique identification for the employee for integration with external systems.
description: string

Maximum Length: 100

Short description

Example: Casual Leave 5
endDateTime: string (date-time)

Indicates the end date/ time period for the unavailability.

Example: 12-31-2018 03:59PM
externalId: string

Maximum Length: 60

Identifier Value
externalSystem: string

Maximum Length: 30

The Work and Asset Management code that represents the external system.

Example: HCM
leaveType: string

Maximum Length: 30

Indicates the type of leave/unavailability for the employee

Example: i.e. Vacation
startDateTime: string (date-time)

Indicates the start date/time period for the unavailability.

Example: 12-25-2018 04:00PM
status: string

Maximum Length: 12

Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected

Example: Approved

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"The Work and Asset Management code that represents the external system.",
            "example":"HCM"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "leaveType":{
            "type":"string",
            "maxLength":30,
            "description":"Indicates the type of leave/unavailability for the employee",
            "example":"i.e. Vacation"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description",
            "example":"Casual Leave 5"
        },
        "applicantId":{
            "type":"string",
            "maxLength":12,
            "description":"Unique identification for the employee for integration with external systems."
        },
        "applicantExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
            "example":"Approved"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Indicates the start date/time period for the unavailability.",
            "example":"12-25-2018 04:00PM"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Indicates the end date/ time period for the unavailability.",
            "example":"12-31-2018 03:59PM"
        }
    }
}

Nested Schema : output

Type: object

Show Source

leaveId: string

(leaveId)

{
    "type":"object",
    "properties":{
        "leaveId":{
            "type":"string",
            "description":"(leaveId)"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : UPDATEADDLEAVE_response

Type: object

Show Source

W1UpdLeave: object W1UpdLeave

{
    "type":"object",
    "properties":{
        "W1UpdLeave":{
            "type":"object",
            "properties":{
                "input":{
                    "type":"object",
                    "properties":{
                        "externalSystem":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The Work and Asset Management code that represents the external system.",
                            "example":"HCM"
                        },
                        "externalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "leaveType":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Indicates the type of leave/unavailability for the employee",
                            "example":"i.e. Vacation"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":100,
                            "description":"Short description",
                            "example":"Casual Leave 5"
                        },
                        "applicantId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Unique identification for the employee for integration with external systems."
                        },
                        "applicantExternalId":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Identifier Value"
                        },
                        "status":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
                            "example":"Approved"
                        },
                        "startDateTime":{
                            "type":"string",
                            "format":"date-time",
                            "description":"Indicates the start date/time period for the unavailability.",
                            "example":"12-25-2018 04:00PM"
                        },
                        "endDateTime":{
                            "type":"string",
                            "format":"date-time",
                            "description":"Indicates the end date/ time period for the unavailability.",
                            "example":"12-31-2018 03:59PM"
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "leaveId":{
                            "type":"string",
                            "description":"(leaveId)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : W1UpdLeave

Type: object

Show Source

input: object input
output: object output

{
    "type":"object",
    "properties":{
        "input":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Work and Asset Management code that represents the external system.",
                    "example":"HCM"
                },
                "externalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "leaveType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Indicates the type of leave/unavailability for the employee",
                    "example":"i.e. Vacation"
                },
                "description":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Short description",
                    "example":"Casual Leave 5"
                },
                "applicantId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Unique identification for the employee for integration with external systems."
                },
                "applicantExternalId":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Identifier Value"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
                    "example":"Approved"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Indicates the start date/time period for the unavailability.",
                    "example":"12-25-2018 04:00PM"
                },
                "endDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Indicates the end date/ time period for the unavailability.",
                    "example":"12-31-2018 03:59PM"
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "leaveId":{
                    "type":"string",
                    "description":"(leaveId)"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

applicantExternalId: string

Maximum Length: 60

Identifier Value
applicantId: string

Maximum Length: 12

Unique identification for the employee for integration with external systems.
description: string

Maximum Length: 100

Short description

Example: Casual Leave 5
endDateTime: string (date-time)

Indicates the end date/ time period for the unavailability.

Example: 12-31-2018 03:59PM
externalId: string

Maximum Length: 60

Identifier Value
externalSystem: string

Maximum Length: 30

The Work and Asset Management code that represents the external system.

Example: HCM
leaveType: string

Maximum Length: 30

Indicates the type of leave/unavailability for the employee

Example: i.e. Vacation
startDateTime: string (date-time)

Indicates the start date/time period for the unavailability.

Example: 12-25-2018 04:00PM
status: string

Maximum Length: 12

Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected

Example: Approved

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"The Work and Asset Management code that represents the external system.",
            "example":"HCM"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "leaveType":{
            "type":"string",
            "maxLength":30,
            "description":"Indicates the type of leave/unavailability for the employee",
            "example":"i.e. Vacation"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description",
            "example":"Casual Leave 5"
        },
        "applicantId":{
            "type":"string",
            "maxLength":12,
            "description":"Unique identification for the employee for integration with external systems."
        },
        "applicantExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"Identifier Value"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected",
            "example":"Approved"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Indicates the start date/time period for the unavailability.",
            "example":"12-25-2018 04:00PM"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Indicates the end date/ time period for the unavailability.",
            "example":"12-31-2018 03:59PM"
        }
    }
}

Nested Schema : output

Type: object

Show Source

leaveId: string

(leaveId)

{
    "type":"object",
    "properties":{
        "leaveId":{
            "type":"string",
            "description":"(leaveId)"
        }
    }
}

400 Response

Bad Request

Root Schema : UPDATEADDLEAVE_error

Type: object

Show Source

problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":60,
                    "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
                },
                "title":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":9999,
                    "minimum":0,
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":0,
                            "minimum":0,
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

detail: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
httpStatus: number

Minimum Value: 0

Maximum Value: 9999

The HTTP Status code for the error.
problemInstance: string

Maximum Length: 60

Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
problemType: string

Maximum Length: 60

URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
serverMessage: object serverMessage
stackTrace: string

Maximum Length: 60

The stack trace shows where the error occurs during the execution of a program.
title: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

callSequence: string

Maximum Length: 60

Delimited sequence of programs called.
longDescription: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
messageCategory: number

Minimum Value: 0

Maximum Value: 0

Message Category within Oracle Utilities Application Framework.
messageNbr: number

Minimum Value: -99999

Maximum Value: 99999

Message Number within Oracle Utilities Application Framework.
messageText: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
programName: string

Maximum Length: 60

Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : UPDATEADDLEAVE_error

Type: object

Show Source

problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":60,
                    "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
                },
                "title":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":9999,
                    "minimum":0,
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":0,
                            "minimum":0,
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

detail: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
httpStatus: number

Minimum Value: 0

Maximum Value: 9999

The HTTP Status code for the error.
problemInstance: string

Maximum Length: 60

Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
problemType: string

Maximum Length: 60

URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
serverMessage: object serverMessage
stackTrace: string

Maximum Length: 60

The stack trace shows where the error occurs during the execution of a program.
title: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

callSequence: string

Maximum Length: 60

Delimited sequence of programs called.
longDescription: string

Maximum Length: 60

The long message description from the Oracle Utilities Application Framework in CDATA format.
messageCategory: number

Minimum Value: 0

Maximum Value: 0

Message Category within Oracle Utilities Application Framework.
messageNbr: number

Minimum Value: -99999

Maximum Value: 99999

Message Number within Oracle Utilities Application Framework.
messageText: string

Maximum Length: 60

Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
programName: string

Maximum Length: 60

Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}