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 ManagementExample:
300000230453798
Supported Media Types
- application/xml
- application/json
Nested Schema : input
Type:
Show Source
object
-
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 descriptionExample: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 employeeExample: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, RejectedExample:Approved
Nested Schema : input
Type:
Show Source
object
-
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 descriptionExample: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 employeeExample: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, RejectedExample:Approved
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object
-
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 descriptionExample: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 employeeExample: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, RejectedExample:Approved
400 Response
Bad Request
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.