Create or Update Craft
put
https://server:port/rest/apis/asset/resources/crafts/{externalSystem}/{externalId}
This REST service synchronizes Enterprise Resource Planning (ERP) - Human Capital Management (HCM) Jobs with Work and Asset Management (WAM) Crafts, by creating WAM Craft records or updating 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
-
externalSystem(required): string
The Work and Asset Management code that represents the external system.Example:
HCM
Supported Media Types
- application/xml
- application/json
Nested Schema : input
Type:
Show Source
object
-
acceptOnReceipt: string
Allowed Values:
[ "W1NO", "W1YS" ]
Applies to contracted resources to indicate whether or not the system can automatically accept the work, or service, without someone reviewing or accepting it manually. * `W1NO` - No, * `W1YS` - YesExample:Yes
-
craftCode: string
Maximum Length:
60
Unique code for the craftExample:IDC_ELECTRICIAN
-
defaultValueToActivity: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the item information should be defaulted onto activities when resource requirements reference the craft. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item. * `W1NO` - No, * `W1YS` - YesExample:Yes
-
description: string
Maximum Length:
100
Short description for a type of craft resource. Typically a special skill or contract worker -
externalId: string
Maximum Length:
60
A unique identifier to the craft as represented in the external system - Human Capital ManagementExample:300000047336894
-
externalSystem: string
Maximum Length:
30
The Work and Asset Management code that represents the external system.Example:HCM
-
longDescription: string
Maximum Length:
4000
Long description for a type of craft resource. Typically a special skill or contract worker - premiumExpenseCode: string
-
regularExpenseCode: string
Maximum Length:
30
Regular expense code for the craftExample:110 - Labor - Regular
-
resourceSource: string
Allowed Values:
[ "W1IN", "W1PR" ]
Provides a reference to where the craft resource can be located or obtained. Internal or Purchased. * `W1IN` - Internal, * `W1PR` - PurchasedExample:Internal, Purchased
-
schedulePriority: number
Minimum Value:
0
Maximum Value:999
A numerical value which is used to denote the order in which the principal craft duration is determined when labor requirement assignments are made to a secondary craft. 1 is a high priority and 999 is a low priority. The default is 100. If two crafts have the same secondary craft, they should be set with different priorities.Example:100
-
status: string
Maximum Length:
12
Craft StatusExample:Active
-
unitPricesList: array
unitPricesList
Nested Schema : output
Type:
Show Source
object
-
craftId: string
Maximum Length:
12
Unique ID sent by Work and Asset Management System on each outbound message
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Date when the Unit Price goes into effectExample:
10-14-2020
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Unit Price for the CraftExample:100
Nested Schema : input
Type:
Show Source
object
-
acceptOnReceipt: string
Allowed Values:
[ "W1NO", "W1YS" ]
Applies to contracted resources to indicate whether or not the system can automatically accept the work, or service, without someone reviewing or accepting it manually. * `W1NO` - No, * `W1YS` - YesExample:Yes
-
craftCode: string
Maximum Length:
60
Unique code for the craftExample:IDC_ELECTRICIAN
-
defaultValueToActivity: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the item information should be defaulted onto activities when resource requirements reference the craft. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item. * `W1NO` - No, * `W1YS` - YesExample:Yes
-
description: string
Maximum Length:
100
Short description for a type of craft resource. Typically a special skill or contract worker -
externalId: string
Maximum Length:
60
A unique identifier to the craft as represented in the external system - Human Capital ManagementExample:300000047336894
-
externalSystem: string
Maximum Length:
30
The Work and Asset Management code that represents the external system.Example:HCM
-
longDescription: string
Maximum Length:
4000
Long description for a type of craft resource. Typically a special skill or contract worker - premiumExpenseCode: string
-
regularExpenseCode: string
Maximum Length:
30
Regular expense code for the craftExample:110 - Labor - Regular
-
resourceSource: string
Allowed Values:
[ "W1IN", "W1PR" ]
Provides a reference to where the craft resource can be located or obtained. Internal or Purchased. * `W1IN` - Internal, * `W1PR` - PurchasedExample:Internal, Purchased
-
schedulePriority: number
Minimum Value:
0
Maximum Value:999
A numerical value which is used to denote the order in which the principal craft duration is determined when labor requirement assignments are made to a secondary craft. 1 is a high priority and 999 is a low priority. The default is 100. If two crafts have the same secondary craft, they should be set with different priorities.Example:100
-
status: string
Maximum Length:
12
Craft StatusExample:Active
-
unitPricesList: array
unitPricesList
Nested Schema : output
Type:
Show Source
object
-
craftId: string
Maximum Length:
12
Unique ID sent by Work and Asset Management System on each outbound message
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Date when the Unit Price goes into effectExample:
10-14-2020
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Unit Price for the CraftExample:100
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object
-
acceptOnReceipt: string
Allowed Values:
[ "W1NO", "W1YS" ]
Applies to contracted resources to indicate whether or not the system can automatically accept the work, or service, without someone reviewing or accepting it manually. * `W1NO` - No, * `W1YS` - YesExample:Yes
-
craftCode: string
Maximum Length:
60
Unique code for the craftExample:IDC_ELECTRICIAN
-
defaultValueToActivity: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the item information should be defaulted onto activities when resource requirements reference the craft. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item. * `W1NO` - No, * `W1YS` - YesExample:Yes
-
description: string
Maximum Length:
100
Short description for a type of craft resource. Typically a special skill or contract worker -
externalId: string
Maximum Length:
60
A unique identifier to the craft as represented in the external system - Human Capital ManagementExample:300000047336894
-
externalSystem: string
Maximum Length:
30
The Work and Asset Management code that represents the external system.Example:HCM
-
longDescription: string
Maximum Length:
4000
Long description for a type of craft resource. Typically a special skill or contract worker - premiumExpenseCode: string
-
regularExpenseCode: string
Maximum Length:
30
Regular expense code for the craftExample:110 - Labor - Regular
-
resourceSource: string
Allowed Values:
[ "W1IN", "W1PR" ]
Provides a reference to where the craft resource can be located or obtained. Internal or Purchased. * `W1IN` - Internal, * `W1PR` - PurchasedExample:Internal, Purchased
-
schedulePriority: number
Minimum Value:
0
Maximum Value:999
A numerical value which is used to denote the order in which the principal craft duration is determined when labor requirement assignments are made to a secondary craft. 1 is a high priority and 999 is a low priority. The default is 100. If two crafts have the same secondary craft, they should be set with different priorities.Example:100
-
status: string
Maximum Length:
12
Craft StatusExample:Active
-
unitPricesList: array
unitPricesList
Nested Schema : output
Type:
Show Source
object
-
craftId: string
Maximum Length:
12
Unique ID sent by Work and Asset Management System on each outbound message
Nested Schema : items
Type:
Show Source
object
-
effectiveDate: string
(date)
Date when the Unit Price goes into effectExample:
10-14-2020
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Unit Price for the CraftExample:100
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.