Synchronize Employee
post
https://server:port/rest/apis/asset/resources/employeeSynchronization/
This REST web service synchronizes Enterprise Resource Planning - Human Capital Management Employee records with Work and Asset Management.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : input
Type:
Show Source
object-
employeeInfo: object
employeeInfo
-
externalReferenceId: string
Maximum Length:
36Variable based on the originating system -
externalSystem: string
Maximum Length:
30Defaulted (value) by the HCM Integration.Example:HCM -
initialLoad: string
Maximum Length:
4Defaulted (value) by the HCM Integration.
Nested Schema : employeeInfo
Type:
Show Source
object-
addressInformation: object
addressInformation
-
billableRates: object
billableRates
-
businessUnit: string
Maximum Length:
30The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.Example:US1 -
creationUser: string
Maximum Length:
8The system username for the employee. Employees do not necessarily have to be defined as users within the system. -
emailAddress: string
Maximum Length:
254Employee's Email address. -
employeeTrainingInformation: object
employeeTrainingInformation
-
employeeType: string
Maximum Length:
30Employee TypeExample:Regular -
externalId: string
Maximum Length:
60Identifier Value -
firstName: string
Maximum Length:
254Employee's First Name. -
hiredDate: string
(date)
Employee's Hired Date.
-
hrEmployeeNumber: string
Maximum Length:
60Identifier Value -
jobCode: string
Maximum Length:
60Identifier Value -
jobTitle: string
Maximum Length:
60Identifier Value -
lastName: string
Maximum Length:
254Employee's Last Name. -
phoneNumbers: object
phoneNumbers
-
principalCraft: string
Maximum Length:
12The main craft that the employee is qualified to work. -
principalCraftExternalId: string
Maximum Length:
60Identifier Value -
status: string
Maximum Length:
12Employee's Current Status.Example:ACTIVE or INACTIVE -
supervisor: string
Maximum Length:
12The username of the employee's supervisor -
terminatedDate: string
(date)
Employee's Termination Date.
Nested Schema : addressInformation
Type:
Show Source
object-
address1: string
Maximum Length:
254The first line for the address, associated with the Purchase Order. -
address2: string
Maximum Length:
254The second line for the address, associated with the Purchase Order. -
address3: string
Maximum Length:
254The third line for the address, associated with the Purchase Order. -
address4: string
Maximum Length:
254The fourth line for the address, associated with the Purchase Order. -
city: string
Maximum Length:
90The City for the PO address. -
country: string
Maximum Length:
3Country -
county: string
Maximum Length:
90The County for the PO address.Example:US -
crossStreet: string
Maximum Length:
64The Cross Street the PO address. -
geographicCode: string
Maximum Length:
11The Geographic Code for the PO address. -
houseType: string
The House Type for the PO address.
-
inCityLimit: boolean
In City Limit
-
number1: string
Maximum Length:
6Street number 1 -
number2: string
Maximum Length:
4Street number 2 -
postal: string
Maximum Length:
12The Postal Code for the PO address. -
state: string
Maximum Length:
6StateExample:CA -
suburb: string
Maximum Length:
64The Suburb for the PO address.
Nested Schema : items
Type:
Show Source
object-
billableRate: number
Billable rate
-
effectiveDate: string
(date)
Billable rates effective date
Nested Schema : items
Type:
Show Source
object-
course: string
Maximum Length:
254Training course number -
effectiveDate: string
(date)
Effective Date
-
employeeNotified: boolean
Employee Notified
-
expirationDate: string
(date)
Expiration Date
-
supervisorNotified: boolean
Supervisor Notified
Nested Schema : items
Type:
Show Source
object-
areaCode: string
Maximum Length:
24Phone -
countryCode: string
Maximum Length:
3Country -
phoneNumber: string
Maximum Length:
24Phone -
phoneType: string
Allowed Values:
[ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ]Phone number type * `FAX ` - Fax, * `SMS ` - Short Message Service, * `W1BS` - Business, * `W1HM` - Home, * `W1MB` - Mobile, * `W1PR` - Primary
Nested Schema : input
Type:
Show Source
object-
employeeInfo: object
employeeInfo
-
externalReferenceId: string
Maximum Length:
36Variable based on the originating system -
externalSystem: string
Maximum Length:
30Defaulted (value) by the HCM Integration.Example:HCM -
initialLoad: string
Maximum Length:
4Defaulted (value) by the HCM Integration.
Nested Schema : employeeInfo
Type:
Show Source
object-
addressInformation: object
addressInformation
-
billableRates: object
billableRates
-
businessUnit: string
Maximum Length:
30The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.Example:US1 -
creationUser: string
Maximum Length:
8The system username for the employee. Employees do not necessarily have to be defined as users within the system. -
emailAddress: string
Maximum Length:
254Employee's Email address. -
employeeTrainingInformation: object
employeeTrainingInformation
-
employeeType: string
Maximum Length:
30Employee TypeExample:Regular -
externalId: string
Maximum Length:
60Identifier Value -
firstName: string
Maximum Length:
254Employee's First Name. -
hiredDate: string
(date)
Employee's Hired Date.
-
hrEmployeeNumber: string
Maximum Length:
60Identifier Value -
jobCode: string
Maximum Length:
60Identifier Value -
jobTitle: string
Maximum Length:
60Identifier Value -
lastName: string
Maximum Length:
254Employee's Last Name. -
phoneNumbers: object
phoneNumbers
-
principalCraft: string
Maximum Length:
12The main craft that the employee is qualified to work. -
principalCraftExternalId: string
Maximum Length:
60Identifier Value -
status: string
Maximum Length:
12Employee's Current Status.Example:ACTIVE or INACTIVE -
supervisor: string
Maximum Length:
12The username of the employee's supervisor -
terminatedDate: string
(date)
Employee's Termination Date.
Nested Schema : addressInformation
Type:
Show Source
object-
address1: string
Maximum Length:
254The first line for the address, associated with the Purchase Order. -
address2: string
Maximum Length:
254The second line for the address, associated with the Purchase Order. -
address3: string
Maximum Length:
254The third line for the address, associated with the Purchase Order. -
address4: string
Maximum Length:
254The fourth line for the address, associated with the Purchase Order. -
city: string
Maximum Length:
90The City for the PO address. -
country: string
Maximum Length:
3Country -
county: string
Maximum Length:
90The County for the PO address.Example:US -
crossStreet: string
Maximum Length:
64The Cross Street the PO address. -
geographicCode: string
Maximum Length:
11The Geographic Code for the PO address. -
houseType: string
The House Type for the PO address.
-
inCityLimit: boolean
In City Limit
-
number1: string
Maximum Length:
6Street number 1 -
number2: string
Maximum Length:
4Street number 2 -
postal: string
Maximum Length:
12The Postal Code for the PO address. -
state: string
Maximum Length:
6StateExample:CA -
suburb: string
Maximum Length:
64The Suburb for the PO address.
Nested Schema : items
Type:
Show Source
object-
billableRate: number
Billable rate
-
effectiveDate: string
(date)
Billable rates effective date
Nested Schema : items
Type:
Show Source
object-
course: string
Maximum Length:
254Training course number -
effectiveDate: string
(date)
Effective Date
-
employeeNotified: boolean
Employee Notified
-
expirationDate: string
(date)
Expiration Date
-
supervisorNotified: boolean
Supervisor Notified
Nested Schema : items
Type:
Show Source
object-
areaCode: string
Maximum Length:
24Phone -
countryCode: string
Maximum Length:
3Country -
phoneNumber: string
Maximum Length:
24Phone -
phoneType: string
Allowed Values:
[ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ]Phone number type * `FAX ` - Fax, * `SMS ` - Short Message Service, * `W1BS` - Business, * `W1HM` - Home, * `W1MB` - Mobile, * `W1PR` - Primary
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object-
employeeInfo: object
employeeInfo
-
externalReferenceId: string
Maximum Length:
36Variable based on the originating system -
externalSystem: string
Maximum Length:
30Defaulted (value) by the HCM Integration.Example:HCM -
initialLoad: string
Maximum Length:
4Defaulted (value) by the HCM Integration.
Nested Schema : employeeInfo
Type:
Show Source
object-
addressInformation: object
addressInformation
-
billableRates: object
billableRates
-
businessUnit: string
Maximum Length:
30The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.Example:US1 -
creationUser: string
Maximum Length:
8The system username for the employee. Employees do not necessarily have to be defined as users within the system. -
emailAddress: string
Maximum Length:
254Employee's Email address. -
employeeTrainingInformation: object
employeeTrainingInformation
-
employeeType: string
Maximum Length:
30Employee TypeExample:Regular -
externalId: string
Maximum Length:
60Identifier Value -
firstName: string
Maximum Length:
254Employee's First Name. -
hiredDate: string
(date)
Employee's Hired Date.
-
hrEmployeeNumber: string
Maximum Length:
60Identifier Value -
jobCode: string
Maximum Length:
60Identifier Value -
jobTitle: string
Maximum Length:
60Identifier Value -
lastName: string
Maximum Length:
254Employee's Last Name. -
phoneNumbers: object
phoneNumbers
-
principalCraft: string
Maximum Length:
12The main craft that the employee is qualified to work. -
principalCraftExternalId: string
Maximum Length:
60Identifier Value -
status: string
Maximum Length:
12Employee's Current Status.Example:ACTIVE or INACTIVE -
supervisor: string
Maximum Length:
12The username of the employee's supervisor -
terminatedDate: string
(date)
Employee's Termination Date.
Nested Schema : addressInformation
Type:
Show Source
object-
address1: string
Maximum Length:
254The first line for the address, associated with the Purchase Order. -
address2: string
Maximum Length:
254The second line for the address, associated with the Purchase Order. -
address3: string
Maximum Length:
254The third line for the address, associated with the Purchase Order. -
address4: string
Maximum Length:
254The fourth line for the address, associated with the Purchase Order. -
city: string
Maximum Length:
90The City for the PO address. -
country: string
Maximum Length:
3Country -
county: string
Maximum Length:
90The County for the PO address.Example:US -
crossStreet: string
Maximum Length:
64The Cross Street the PO address. -
geographicCode: string
Maximum Length:
11The Geographic Code for the PO address. -
houseType: string
The House Type for the PO address.
-
inCityLimit: boolean
In City Limit
-
number1: string
Maximum Length:
6Street number 1 -
number2: string
Maximum Length:
4Street number 2 -
postal: string
Maximum Length:
12The Postal Code for the PO address. -
state: string
Maximum Length:
6StateExample:CA -
suburb: string
Maximum Length:
64The Suburb for the PO address.
Nested Schema : items
Type:
Show Source
object-
billableRate: number
Billable rate
-
effectiveDate: string
(date)
Billable rates effective date
Nested Schema : items
Type:
Show Source
object-
course: string
Maximum Length:
254Training course number -
effectiveDate: string
(date)
Effective Date
-
employeeNotified: boolean
Employee Notified
-
expirationDate: string
(date)
Expiration Date
-
supervisorNotified: boolean
Supervisor Notified
Nested Schema : items
Type:
Show Source
object-
areaCode: string
Maximum Length:
24Phone -
countryCode: string
Maximum Length:
3Country -
phoneNumber: string
Maximum Length:
24Phone -
phoneType: string
Allowed Values:
[ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ]Phone number type * `FAX ` - Fax, * `SMS ` - Short Message Service, * `W1BS` - Business, * `W1HM` - Home, * `W1MB` - Mobile, * `W1PR` - Primary
400 Response
Bad Request
Nested Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.
500 Response
Internal Server Error
Nested Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.