Jump to

• Request
• Response

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 Management

  Example:

  300000230453798

• externalSystem(required): string
  The Work and Asset Management code that represents the external system.

  Example:

  HCM

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
                    "example":"300000047336894"
                },
                "craftCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Unique code for the craft",
                    "example":"IDC_ELECTRICIAN"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Craft Status",
                    "example":"Active"
                },
                "description":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":4000,
                    "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
                },
                "resourceSource":{
                    "type":"string",
                    "enum":[
                        "W1IN",
                        "W1PR"
                    ],
                    "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
                    "example":"Internal, Purchased"
                },
                "defaultValueToActivity":{
                    "type":"string",
                    "enum":[
                        "W1NO",
                        "W1YS"
                    ],
                    "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                    "example":"Yes"
                },
                "acceptOnReceipt":{
                    "type":"string",
                    "enum":[
                        "W1NO",
                        "W1YS"
                    ],
                    "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                    "example":"Yes"
                },
                "schedulePriority":{
                    "type":"number",
                    "maximum":999,
                    "minimum":0,
                    "description":"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"
                },
                "unitPricesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Date when the Unit Price goes into effect",
                                "example":"10-14-2020"
                            },
                            "unitPrice":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"Unit Price for the Craft",
                                "example":"100"
                            }
                        }
                    }
                },
                "regularExpenseCode":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Regular expense code for the craft",
                    "example":"110 - Labor - Regular"
                },
                "premiumExpenseCode":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Premium expense code for the craft",
                    "example":"120 - Labor - Premium"
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "craftId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Unique ID sent by Work and Asset Management System on each outbound message"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• 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` - Yes

  Example: Yes
• craftCode: string
  Maximum Length: 60

  Unique code for the craft

  Example: 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` - Yes

  Example: 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 Management

  Example: 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
  Maximum Length: 30

  Premium expense code for the craft

  Example: 120 - Labor - Premium
• regularExpenseCode: string
  Maximum Length: 30

  Regular expense code for the craft

  Example: 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` - Purchased

  Example: 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 Status

  Example: Active
• unitPricesList: array unitPricesList

{
    "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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
            "example":"300000047336894"
        },
        "craftCode":{
            "type":"string",
            "maxLength":60,
            "description":"Unique code for the craft",
            "example":"IDC_ELECTRICIAN"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Craft Status",
            "example":"Active"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
        },
        "longDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
        },
        "resourceSource":{
            "type":"string",
            "enum":[
                "W1IN",
                "W1PR"
            ],
            "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
            "example":"Internal, Purchased"
        },
        "defaultValueToActivity":{
            "type":"string",
            "enum":[
                "W1NO",
                "W1YS"
            ],
            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
            "example":"Yes"
        },
        "acceptOnReceipt":{
            "type":"string",
            "enum":[
                "W1NO",
                "W1YS"
            ],
            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
            "example":"Yes"
        },
        "schedulePriority":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"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"
        },
        "unitPricesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Date when the Unit Price goes into effect",
                        "example":"10-14-2020"
                    },
                    "unitPrice":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"Unit Price for the Craft",
                        "example":"100"
                    }
                }
            }
        },
        "regularExpenseCode":{
            "type":"string",
            "maxLength":30,
            "description":"Regular expense code for the craft",
            "example":"110 - Labor - Regular"
        },
        "premiumExpenseCode":{
            "type":"string",
            "maxLength":30,
            "description":"Premium expense code for the craft",
            "example":"120 - Labor - Premium"
        }
    }
}

Nested Schema : output

Type: object

Show Source

• craftId: string
  Maximum Length: 12

  Unique ID sent by Work and Asset Management System on each outbound message

{
    "type":"object",
    "properties":{
        "craftId":{
            "type":"string",
            "maxLength":12,
            "description":"Unique ID sent by Work and Asset Management System on each outbound message"
        }
    }
}

Nested Schema : unitPricesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Date when the Unit Price goes into effect",
                "example":"10-14-2020"
            },
            "unitPrice":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"Unit Price for the Craft",
                "example":"100"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveDate: string (date)
  Date when the Unit Price goes into effect

  Example: 10-14-2020
• unitPrice: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  Unit Price for the Craft

  Example: 100

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Date when the Unit Price goes into effect",
            "example":"10-14-2020"
        },
        "unitPrice":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"Unit Price for the Craft",
            "example":"100"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• W1UpdAdCraft: object schema

{
    "type":"object",
    "properties":{
        "W1UpdAdCraft":{
            "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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
                            "example":"300000047336894"
                        },
                        "craftCode":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Unique code for the craft",
                            "example":"IDC_ELECTRICIAN"
                        },
                        "status":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Craft Status",
                            "example":"Active"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":100,
                            "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":4000,
                            "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
                        },
                        "resourceSource":{
                            "type":"string",
                            "enum":[
                                "W1IN",
                                "W1PR"
                            ],
                            "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
                            "example":"Internal, Purchased"
                        },
                        "defaultValueToActivity":{
                            "type":"string",
                            "enum":[
                                "W1NO",
                                "W1YS"
                            ],
                            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                            "example":"Yes"
                        },
                        "acceptOnReceipt":{
                            "type":"string",
                            "enum":[
                                "W1NO",
                                "W1YS"
                            ],
                            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                            "example":"Yes"
                        },
                        "schedulePriority":{
                            "type":"number",
                            "maximum":999,
                            "minimum":0,
                            "description":"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"
                        },
                        "unitPricesList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Date when the Unit Price goes into effect",
                                        "example":"10-14-2020"
                                    },
                                    "unitPrice":{
                                        "type":"number",
                                        "maximum":1.0E11,
                                        "minimum":-1.0E11,
                                        "description":"Unit Price for the Craft",
                                        "example":"100"
                                    }
                                }
                            }
                        },
                        "regularExpenseCode":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Regular expense code for the craft",
                            "example":"110 - Labor - Regular"
                        },
                        "premiumExpenseCode":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Premium expense code for the craft",
                            "example":"120 - Labor - Premium"
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "craftId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Unique ID sent by Work and Asset Management System on each outbound message"
                        }
                    }
                }
            }
        }
    }
}

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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
                    "example":"300000047336894"
                },
                "craftCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Unique code for the craft",
                    "example":"IDC_ELECTRICIAN"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Craft Status",
                    "example":"Active"
                },
                "description":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":4000,
                    "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
                },
                "resourceSource":{
                    "type":"string",
                    "enum":[
                        "W1IN",
                        "W1PR"
                    ],
                    "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
                    "example":"Internal, Purchased"
                },
                "defaultValueToActivity":{
                    "type":"string",
                    "enum":[
                        "W1NO",
                        "W1YS"
                    ],
                    "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                    "example":"Yes"
                },
                "acceptOnReceipt":{
                    "type":"string",
                    "enum":[
                        "W1NO",
                        "W1YS"
                    ],
                    "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                    "example":"Yes"
                },
                "schedulePriority":{
                    "type":"number",
                    "maximum":999,
                    "minimum":0,
                    "description":"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"
                },
                "unitPricesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Date when the Unit Price goes into effect",
                                "example":"10-14-2020"
                            },
                            "unitPrice":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"Unit Price for the Craft",
                                "example":"100"
                            }
                        }
                    }
                },
                "regularExpenseCode":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Regular expense code for the craft",
                    "example":"110 - Labor - Regular"
                },
                "premiumExpenseCode":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Premium expense code for the craft",
                    "example":"120 - Labor - Premium"
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "craftId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Unique ID sent by Work and Asset Management System on each outbound message"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• 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` - Yes

  Example: Yes
• craftCode: string
  Maximum Length: 60

  Unique code for the craft

  Example: 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` - Yes

  Example: 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 Management

  Example: 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
  Maximum Length: 30

  Premium expense code for the craft

  Example: 120 - Labor - Premium
• regularExpenseCode: string
  Maximum Length: 30

  Regular expense code for the craft

  Example: 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` - Purchased

  Example: 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 Status

  Example: Active
• unitPricesList: array unitPricesList

{
    "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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
            "example":"300000047336894"
        },
        "craftCode":{
            "type":"string",
            "maxLength":60,
            "description":"Unique code for the craft",
            "example":"IDC_ELECTRICIAN"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Craft Status",
            "example":"Active"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
        },
        "longDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
        },
        "resourceSource":{
            "type":"string",
            "enum":[
                "W1IN",
                "W1PR"
            ],
            "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
            "example":"Internal, Purchased"
        },
        "defaultValueToActivity":{
            "type":"string",
            "enum":[
                "W1NO",
                "W1YS"
            ],
            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
            "example":"Yes"
        },
        "acceptOnReceipt":{
            "type":"string",
            "enum":[
                "W1NO",
                "W1YS"
            ],
            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
            "example":"Yes"
        },
        "schedulePriority":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"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"
        },
        "unitPricesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Date when the Unit Price goes into effect",
                        "example":"10-14-2020"
                    },
                    "unitPrice":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"Unit Price for the Craft",
                        "example":"100"
                    }
                }
            }
        },
        "regularExpenseCode":{
            "type":"string",
            "maxLength":30,
            "description":"Regular expense code for the craft",
            "example":"110 - Labor - Regular"
        },
        "premiumExpenseCode":{
            "type":"string",
            "maxLength":30,
            "description":"Premium expense code for the craft",
            "example":"120 - Labor - Premium"
        }
    }
}

Nested Schema : output

Type: object

Show Source

• craftId: string
  Maximum Length: 12

  Unique ID sent by Work and Asset Management System on each outbound message

{
    "type":"object",
    "properties":{
        "craftId":{
            "type":"string",
            "maxLength":12,
            "description":"Unique ID sent by Work and Asset Management System on each outbound message"
        }
    }
}

Nested Schema : unitPricesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Date when the Unit Price goes into effect",
                "example":"10-14-2020"
            },
            "unitPrice":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"Unit Price for the Craft",
                "example":"100"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveDate: string (date)
  Date when the Unit Price goes into effect

  Example: 10-14-2020
• unitPrice: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  Unit Price for the Craft

  Example: 100

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Date when the Unit Price goes into effect",
            "example":"10-14-2020"
        },
        "unitPrice":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"Unit Price for the Craft",
            "example":"100"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : EXTERNALUPDATEADDCRAFT_response

Type: object

Show Source

• W1UpdAdCraft: object W1UpdAdCraft

{
    "type":"object",
    "properties":{
        "W1UpdAdCraft":{
            "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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
                            "example":"300000047336894"
                        },
                        "craftCode":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Unique code for the craft",
                            "example":"IDC_ELECTRICIAN"
                        },
                        "status":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Craft Status",
                            "example":"Active"
                        },
                        "description":{
                            "type":"string",
                            "maxLength":100,
                            "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":4000,
                            "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
                        },
                        "resourceSource":{
                            "type":"string",
                            "enum":[
                                "W1IN",
                                "W1PR"
                            ],
                            "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
                            "example":"Internal, Purchased"
                        },
                        "defaultValueToActivity":{
                            "type":"string",
                            "enum":[
                                "W1NO",
                                "W1YS"
                            ],
                            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                            "example":"Yes"
                        },
                        "acceptOnReceipt":{
                            "type":"string",
                            "enum":[
                                "W1NO",
                                "W1YS"
                            ],
                            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                            "example":"Yes"
                        },
                        "schedulePriority":{
                            "type":"number",
                            "maximum":999,
                            "minimum":0,
                            "description":"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"
                        },
                        "unitPricesList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Date when the Unit Price goes into effect",
                                        "example":"10-14-2020"
                                    },
                                    "unitPrice":{
                                        "type":"number",
                                        "maximum":1.0E11,
                                        "minimum":-1.0E11,
                                        "description":"Unit Price for the Craft",
                                        "example":"100"
                                    }
                                }
                            }
                        },
                        "regularExpenseCode":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Regular expense code for the craft",
                            "example":"110 - Labor - Regular"
                        },
                        "premiumExpenseCode":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Premium expense code for the craft",
                            "example":"120 - Labor - Premium"
                        }
                    }
                },
                "output":{
                    "type":"object",
                    "properties":{
                        "craftId":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Unique ID sent by Work and Asset Management System on each outbound message"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : W1UpdAdCraft

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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
                    "example":"300000047336894"
                },
                "craftCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Unique code for the craft",
                    "example":"IDC_ELECTRICIAN"
                },
                "status":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Craft Status",
                    "example":"Active"
                },
                "description":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":4000,
                    "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
                },
                "resourceSource":{
                    "type":"string",
                    "enum":[
                        "W1IN",
                        "W1PR"
                    ],
                    "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
                    "example":"Internal, Purchased"
                },
                "defaultValueToActivity":{
                    "type":"string",
                    "enum":[
                        "W1NO",
                        "W1YS"
                    ],
                    "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                    "example":"Yes"
                },
                "acceptOnReceipt":{
                    "type":"string",
                    "enum":[
                        "W1NO",
                        "W1YS"
                    ],
                    "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
                    "example":"Yes"
                },
                "schedulePriority":{
                    "type":"number",
                    "maximum":999,
                    "minimum":0,
                    "description":"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"
                },
                "unitPricesList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Date when the Unit Price goes into effect",
                                "example":"10-14-2020"
                            },
                            "unitPrice":{
                                "type":"number",
                                "maximum":1.0E11,
                                "minimum":-1.0E11,
                                "description":"Unit Price for the Craft",
                                "example":"100"
                            }
                        }
                    }
                },
                "regularExpenseCode":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Regular expense code for the craft",
                    "example":"110 - Labor - Regular"
                },
                "premiumExpenseCode":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Premium expense code for the craft",
                    "example":"120 - Labor - Premium"
                }
            }
        },
        "output":{
            "type":"object",
            "properties":{
                "craftId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Unique ID sent by Work and Asset Management System on each outbound message"
                }
            }
        }
    }
}

Nested Schema : input

Type: object

Show Source

• 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` - Yes

  Example: Yes
• craftCode: string
  Maximum Length: 60

  Unique code for the craft

  Example: 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` - Yes

  Example: 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 Management

  Example: 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
  Maximum Length: 30

  Premium expense code for the craft

  Example: 120 - Labor - Premium
• regularExpenseCode: string
  Maximum Length: 30

  Regular expense code for the craft

  Example: 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` - Purchased

  Example: 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 Status

  Example: Active
• unitPricesList: array unitPricesList

{
    "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":"A unique identifier to the craft as represented in the external system  - Human Capital Management",
            "example":"300000047336894"
        },
        "craftCode":{
            "type":"string",
            "maxLength":60,
            "description":"Unique code for the craft",
            "example":"IDC_ELECTRICIAN"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Craft Status",
            "example":"Active"
        },
        "description":{
            "type":"string",
            "maxLength":100,
            "description":"Short description for a type of craft resource. Typically a special skill or contract worker"
        },
        "longDescription":{
            "type":"string",
            "maxLength":4000,
            "description":"Long description for a type of craft resource. Typically a special skill or contract worker"
        },
        "resourceSource":{
            "type":"string",
            "enum":[
                "W1IN",
                "W1PR"
            ],
            "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased",
            "example":"Internal, Purchased"
        },
        "defaultValueToActivity":{
            "type":"string",
            "enum":[
                "W1NO",
                "W1YS"
            ],
            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
            "example":"Yes"
        },
        "acceptOnReceipt":{
            "type":"string",
            "enum":[
                "W1NO",
                "W1YS"
            ],
            "description":"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.\n* `W1NO` - No,\n* `W1YS` - Yes",
            "example":"Yes"
        },
        "schedulePriority":{
            "type":"number",
            "maximum":999,
            "minimum":0,
            "description":"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"
        },
        "unitPricesList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Date when the Unit Price goes into effect",
                        "example":"10-14-2020"
                    },
                    "unitPrice":{
                        "type":"number",
                        "maximum":1.0E11,
                        "minimum":-1.0E11,
                        "description":"Unit Price for the Craft",
                        "example":"100"
                    }
                }
            }
        },
        "regularExpenseCode":{
            "type":"string",
            "maxLength":30,
            "description":"Regular expense code for the craft",
            "example":"110 - Labor - Regular"
        },
        "premiumExpenseCode":{
            "type":"string",
            "maxLength":30,
            "description":"Premium expense code for the craft",
            "example":"120 - Labor - Premium"
        }
    }
}

Nested Schema : output

Type: object

Show Source

• craftId: string
  Maximum Length: 12

  Unique ID sent by Work and Asset Management System on each outbound message

{
    "type":"object",
    "properties":{
        "craftId":{
            "type":"string",
            "maxLength":12,
            "description":"Unique ID sent by Work and Asset Management System on each outbound message"
        }
    }
}

Nested Schema : unitPricesList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Date when the Unit Price goes into effect",
                "example":"10-14-2020"
            },
            "unitPrice":{
                "type":"number",
                "maximum":1.0E11,
                "minimum":-1.0E11,
                "description":"Unit Price for the Craft",
                "example":"100"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• effectiveDate: string (date)
  Date when the Unit Price goes into effect

  Example: 10-14-2020
• unitPrice: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  Unit Price for the Craft

  Example: 100

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Date when the Unit Price goes into effect",
            "example":"10-14-2020"
        },
        "unitPrice":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"Unit Price for the Craft",
            "example":"100"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : EXTERNALUPDATEADDCRAFT_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

Body ()

Root Schema : EXTERNALUPDATEADDCRAFT_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."
        }
    }
}

Back to Top