Synchronize Stock Item
post
https://server:port/rest/apis/asset/inventory/stockItemSync/sync
A stock item sync request record manages the creation or update of a stock item.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000228404035
-
externalSystem: string
Maximum Length:
30
The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP
-
initialLoad: string
Maximum Length:
4
Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.Example:F1IL
-
stockItemInfo: object
stockItemInfo
Nested Schema : stockItemInfo
Type:
Show Source
object
-
boStatus: string
Maximum Length:
12
Status of the item based on business object lifecycle.Example:Active
-
capitalSpare: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item is a relatively valuable piece of equipment kept in the house as a backup if the item in use should fail. Items such as a spare motor or generator might fall into this category.Example:W1NO
-
commodityCategory: string
Maximum Length:
30
The highest level, or most general categorization of an item.Example:Mechanical Items
-
commodityComposition: string
Maximum Length:
30
For each category, name, and type combination, there is a unique list of Commodity Compositions. The composition code is used to indicate the primary material in the item.Example:Titanium alloy
-
commodityName: string
Maximum Length:
30
For each category, there is a unique list of Commodity Names.Example:Check Valve.
-
commoditySize: number
Minimum Value:
0
Maximum Value:0
Commodity Size ID (number) provided by ERPExample:12
-
commodityType: string
Maximum Length:
30
For each category and name combination, there is a unique list of Commodity Types.Example:High-pressure pneumatic check valve.
-
defaultValueToActivity: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the stock item information should default onto activities when resource requirements reference the stock item. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item.Example:W1YS
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the stock item.Example:Residential Gas Meter
-
doNotSubstitute: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates that you do not want the vendor to substitute the item with an alternate.Example:W1YS
-
hazardous: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item may be hazardous in some way.Example:W1YS
-
hazardousType: string
Allowed Values:
[ "ZZ01", "ZZCH", "ZZEL" ]
Indicates the type of hazard for hazardous items.Example:GDAC
-
inventoryExpenseCode: string
Maximum Length:
30
Indicates the expense code that will be charged for costs related to the storeroom housing the stock item. If specified, it overrides the Inventory Expense Code on the storeroom.Example:WD-Inventory
-
longDescription: string
Maximum Length:
4000
Longer description up to 4000 characters for the stock item.Example:Meter, Flow, FMU861, Endress-Hauser
-
lotManaged: string
Allowed Values:
[ "W1NO", "W1YS" ]
Lot Managed: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
manufacturers: object
manufacturers
-
propertyUnit: string
Maximum Length:
30
Property units are associated with stock items to indicate when a compatible unit of that stock item is built and should be used to create a fixed asset.Example:Blade
-
purchaseCommodity: string
Maximum Length:
30
The commodity classification for the stock item.Example:Mechanical
-
purchaseToIssueRatio: number
Minimum Value:
0
Maximum Value:99999999
The system calculates the Purchase to Issue Ratio using the Unit of Purchase by the Unit of Issue. For instance, issue in individual items but order the items by the box where one box would contain 10 individual items. The Unit of Purchase would then be BOX, the Unit of Issue would be EACH, and the P-I ratio would be 10.Example:10
-
repairable: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the item is eligible to be repaired, should it fail.Example:W1YS
-
resourceTypeExternalId: string
Maximum Length:
60
External IDExample:300000228404035
-
shelfLife: number
Minimum Value:
0
Maximum Value:999999
Indicates the number of days that perishable items can remain in stores before it is no longer useful.Example:120
-
statusReason: string
Maximum Length:
30
Additional information about why a stock item transitioned to a new status.Example: -
stockCategory: string
Allowed Values:
[ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ]
Categorization for stock items based on your organization's business practices.Example:WDBE
-
stockItem: string
Maximum Length:
60
The unique record IDs of the stock item, used as the stock code in Work and Asset Management.Example:0000001
-
taxRateSchedule: string
Maximum Length:
30
Indicates the tax schedule applicable to the purchase. The drop-down list is defined by entries in the Tax Rate Schedule portal.Example: -
trackable: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item is trackable. Trackable stock items merit being individually identified and followed from initial receipt on-site through complete usage. These are typically large, expensive, or specialized assets or materials, which are inspected when they are received into inventory, repaired if they break, can be installed on other assets, and are otherwise carefully dispositioned in the system.Example:W1NO
-
unitOfIssue: string
Maximum Length:
30
The Unit of Issue defines the type of unit used to issue an item.The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.Example:WD-Each
-
unitOfPurchase: string
Maximum Length:
30
The Unit of Purchase defines the type of unit used to order an item, such as BOX. The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.Example:WD-Each
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
The average unit price at the unit of issue. Users can update it for a brand new stock item for a cost estimate.Example:$8900.00
-
usageExpenseCode: string
Maximum Length:
30
Indicates the expense code that will be charged for costs related to the stock item being utilized.Example:WD-Inventory
-
vendors: object
vendors
Nested Schema : items
Type:
Show Source
object
-
bomId: string
Maximum Length:
12
A Bill of Material (BOM) is a list containing a hierarchy of component parts that make up a piece of equipment or asset. The component parts, also known as BOM Parts, are the individual stock items or an assembly of stock items included in the BOMExample:000123456789
-
copyToPO: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.Example:W1YS
-
manufacturerCode: string
Maximum Length:
30
Display the manufacturer of the asset.Example:WD-ABCElectronics
-
manufacturerPartNumber: string
Maximum Length:
60
A number that uniquely identifies the manufacturer partExample:4.978284
Nested Schema : items
Type:
Show Source
object
-
vendorLocationExternalId: string
Maximum Length:
60
External IDExample:WD-AGMElectronics
-
vendorLocationId: string
Maximum Length:
12
One or many vendor locations are defined for each vendor to distinguish between multiple vendor sites. Each location provides more detailed information about the vendor site such as an address, capabilities, payment details, contacts, and so on.Example:000123456789
-
vendorPartNumber: string
Maximum Length:
60
A number that uniquely identifies the supplier part.Example:5.76382
-
vendorPriority: string
Allowed Values:
[ "W1OT", "W1PR" ]
Used to denote which is the primary supplier of the item. At least one vendor must be set as primary.Example:W1PR
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000228404035
-
externalSystem: string
Maximum Length:
30
The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP
-
initialLoad: string
Maximum Length:
4
Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.Example:F1IL
-
stockItemInfo: object
stockItemInfo
Nested Schema : stockItemInfo
Type:
Show Source
object
-
boStatus: string
Maximum Length:
12
Status of the item based on business object lifecycle.Example:Active
-
capitalSpare: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item is a relatively valuable piece of equipment kept in the house as a backup if the item in use should fail. Items such as a spare motor or generator might fall into this category.Example:W1NO
-
commodityCategory: string
Maximum Length:
30
The highest level, or most general categorization of an item.Example:Mechanical Items
-
commodityComposition: string
Maximum Length:
30
For each category, name, and type combination, there is a unique list of Commodity Compositions. The composition code is used to indicate the primary material in the item.Example:Titanium alloy
-
commodityName: string
Maximum Length:
30
For each category, there is a unique list of Commodity Names.Example:Check Valve.
-
commoditySize: number
Minimum Value:
0
Maximum Value:0
Commodity Size ID (number) provided by ERPExample:12
-
commodityType: string
Maximum Length:
30
For each category and name combination, there is a unique list of Commodity Types.Example:High-pressure pneumatic check valve.
-
defaultValueToActivity: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the stock item information should default onto activities when resource requirements reference the stock item. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item.Example:W1YS
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the stock item.Example:Residential Gas Meter
-
doNotSubstitute: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates that you do not want the vendor to substitute the item with an alternate.Example:W1YS
-
hazardous: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item may be hazardous in some way.Example:W1YS
-
hazardousType: string
Allowed Values:
[ "ZZ01", "ZZCH", "ZZEL" ]
Indicates the type of hazard for hazardous items.Example:GDAC
-
inventoryExpenseCode: string
Maximum Length:
30
Indicates the expense code that will be charged for costs related to the storeroom housing the stock item. If specified, it overrides the Inventory Expense Code on the storeroom.Example:WD-Inventory
-
longDescription: string
Maximum Length:
4000
Longer description up to 4000 characters for the stock item.Example:Meter, Flow, FMU861, Endress-Hauser
-
lotManaged: string
Allowed Values:
[ "W1NO", "W1YS" ]
Lot Managed: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
manufacturers: object
manufacturers
-
propertyUnit: string
Maximum Length:
30
Property units are associated with stock items to indicate when a compatible unit of that stock item is built and should be used to create a fixed asset.Example:Blade
-
purchaseCommodity: string
Maximum Length:
30
The commodity classification for the stock item.Example:Mechanical
-
purchaseToIssueRatio: number
Minimum Value:
0
Maximum Value:99999999
The system calculates the Purchase to Issue Ratio using the Unit of Purchase by the Unit of Issue. For instance, issue in individual items but order the items by the box where one box would contain 10 individual items. The Unit of Purchase would then be BOX, the Unit of Issue would be EACH, and the P-I ratio would be 10.Example:10
-
repairable: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the item is eligible to be repaired, should it fail.Example:W1YS
-
resourceTypeExternalId: string
Maximum Length:
60
External IDExample:300000228404035
-
shelfLife: number
Minimum Value:
0
Maximum Value:999999
Indicates the number of days that perishable items can remain in stores before it is no longer useful.Example:120
-
statusReason: string
Maximum Length:
30
Additional information about why a stock item transitioned to a new status.Example: -
stockCategory: string
Allowed Values:
[ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ]
Categorization for stock items based on your organization's business practices.Example:WDBE
-
stockItem: string
Maximum Length:
60
The unique record IDs of the stock item, used as the stock code in Work and Asset Management.Example:0000001
-
taxRateSchedule: string
Maximum Length:
30
Indicates the tax schedule applicable to the purchase. The drop-down list is defined by entries in the Tax Rate Schedule portal.Example: -
trackable: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item is trackable. Trackable stock items merit being individually identified and followed from initial receipt on-site through complete usage. These are typically large, expensive, or specialized assets or materials, which are inspected when they are received into inventory, repaired if they break, can be installed on other assets, and are otherwise carefully dispositioned in the system.Example:W1NO
-
unitOfIssue: string
Maximum Length:
30
The Unit of Issue defines the type of unit used to issue an item.The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.Example:WD-Each
-
unitOfPurchase: string
Maximum Length:
30
The Unit of Purchase defines the type of unit used to order an item, such as BOX. The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.Example:WD-Each
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
The average unit price at the unit of issue. Users can update it for a brand new stock item for a cost estimate.Example:$8900.00
-
usageExpenseCode: string
Maximum Length:
30
Indicates the expense code that will be charged for costs related to the stock item being utilized.Example:WD-Inventory
-
vendors: object
vendors
Nested Schema : items
Type:
Show Source
object
-
bomId: string
Maximum Length:
12
A Bill of Material (BOM) is a list containing a hierarchy of component parts that make up a piece of equipment or asset. The component parts, also known as BOM Parts, are the individual stock items or an assembly of stock items included in the BOMExample:000123456789
-
copyToPO: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.Example:W1YS
-
manufacturerCode: string
Maximum Length:
30
Display the manufacturer of the asset.Example:WD-ABCElectronics
-
manufacturerPartNumber: string
Maximum Length:
60
A number that uniquely identifies the manufacturer partExample:4.978284
Nested Schema : items
Type:
Show Source
object
-
vendorLocationExternalId: string
Maximum Length:
60
External IDExample:WD-AGMElectronics
-
vendorLocationId: string
Maximum Length:
12
One or many vendor locations are defined for each vendor to distinguish between multiple vendor sites. Each location provides more detailed information about the vendor site such as an address, capabilities, payment details, contacts, and so on.Example:000123456789
-
vendorPartNumber: string
Maximum Length:
60
A number that uniquely identifies the supplier part.Example:5.76382
-
vendorPriority: string
Allowed Values:
[ "W1OT", "W1PR" ]
Used to denote which is the primary supplier of the item. At least one vendor must be set as primary.Example:W1PR
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000228404035
-
externalSystem: string
Maximum Length:
30
The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.Example:ERP
-
initialLoad: string
Maximum Length:
4
Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.Example:F1IL
-
stockItemInfo: object
stockItemInfo
Nested Schema : stockItemInfo
Type:
Show Source
object
-
boStatus: string
Maximum Length:
12
Status of the item based on business object lifecycle.Example:Active
-
capitalSpare: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item is a relatively valuable piece of equipment kept in the house as a backup if the item in use should fail. Items such as a spare motor or generator might fall into this category.Example:W1NO
-
commodityCategory: string
Maximum Length:
30
The highest level, or most general categorization of an item.Example:Mechanical Items
-
commodityComposition: string
Maximum Length:
30
For each category, name, and type combination, there is a unique list of Commodity Compositions. The composition code is used to indicate the primary material in the item.Example:Titanium alloy
-
commodityName: string
Maximum Length:
30
For each category, there is a unique list of Commodity Names.Example:Check Valve.
-
commoditySize: number
Minimum Value:
0
Maximum Value:0
Commodity Size ID (number) provided by ERPExample:12
-
commodityType: string
Maximum Length:
30
For each category and name combination, there is a unique list of Commodity Types.Example:High-pressure pneumatic check valve.
-
defaultValueToActivity: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the stock item information should default onto activities when resource requirements reference the stock item. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item.Example:W1YS
-
description: string
Maximum Length:
100
Brief description up to 100 characters for the stock item.Example:Residential Gas Meter
-
doNotSubstitute: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates that you do not want the vendor to substitute the item with an alternate.Example:W1YS
-
hazardous: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item may be hazardous in some way.Example:W1YS
-
hazardousType: string
Allowed Values:
[ "ZZ01", "ZZCH", "ZZEL" ]
Indicates the type of hazard for hazardous items.Example:GDAC
-
inventoryExpenseCode: string
Maximum Length:
30
Indicates the expense code that will be charged for costs related to the storeroom housing the stock item. If specified, it overrides the Inventory Expense Code on the storeroom.Example:WD-Inventory
-
longDescription: string
Maximum Length:
4000
Longer description up to 4000 characters for the stock item.Example:Meter, Flow, FMU861, Endress-Hauser
-
lotManaged: string
Allowed Values:
[ "W1NO", "W1YS" ]
Lot Managed: * `W1NO` - No, * `W1YS` - YesExample:W1YS
-
manufacturers: object
manufacturers
-
propertyUnit: string
Maximum Length:
30
Property units are associated with stock items to indicate when a compatible unit of that stock item is built and should be used to create a fixed asset.Example:Blade
-
purchaseCommodity: string
Maximum Length:
30
The commodity classification for the stock item.Example:Mechanical
-
purchaseToIssueRatio: number
Minimum Value:
0
Maximum Value:99999999
The system calculates the Purchase to Issue Ratio using the Unit of Purchase by the Unit of Issue. For instance, issue in individual items but order the items by the box where one box would contain 10 individual items. The Unit of Purchase would then be BOX, the Unit of Issue would be EACH, and the P-I ratio would be 10.Example:10
-
repairable: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether or not the item is eligible to be repaired, should it fail.Example:W1YS
-
resourceTypeExternalId: string
Maximum Length:
60
External IDExample:300000228404035
-
shelfLife: number
Minimum Value:
0
Maximum Value:999999
Indicates the number of days that perishable items can remain in stores before it is no longer useful.Example:120
-
statusReason: string
Maximum Length:
30
Additional information about why a stock item transitioned to a new status.Example: -
stockCategory: string
Allowed Values:
[ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ]
Categorization for stock items based on your organization's business practices.Example:WDBE
-
stockItem: string
Maximum Length:
60
The unique record IDs of the stock item, used as the stock code in Work and Asset Management.Example:0000001
-
taxRateSchedule: string
Maximum Length:
30
Indicates the tax schedule applicable to the purchase. The drop-down list is defined by entries in the Tax Rate Schedule portal.Example: -
trackable: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether the item is trackable. Trackable stock items merit being individually identified and followed from initial receipt on-site through complete usage. These are typically large, expensive, or specialized assets or materials, which are inspected when they are received into inventory, repaired if they break, can be installed on other assets, and are otherwise carefully dispositioned in the system.Example:W1NO
-
unitOfIssue: string
Maximum Length:
30
The Unit of Issue defines the type of unit used to issue an item.The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.Example:WD-Each
-
unitOfPurchase: string
Maximum Length:
30
The Unit of Purchase defines the type of unit used to order an item, such as BOX. The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.Example:WD-Each
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
The average unit price at the unit of issue. Users can update it for a brand new stock item for a cost estimate.Example:$8900.00
-
usageExpenseCode: string
Maximum Length:
30
Indicates the expense code that will be charged for costs related to the stock item being utilized.Example:WD-Inventory
-
vendors: object
vendors
Nested Schema : items
Type:
Show Source
object
-
bomId: string
Maximum Length:
12
A Bill of Material (BOM) is a list containing a hierarchy of component parts that make up a piece of equipment or asset. The component parts, also known as BOM Parts, are the individual stock items or an assembly of stock items included in the BOMExample:000123456789
-
copyToPO: string
Allowed Values:
[ "W1NO", "W1YS" ]
Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.Example:W1YS
-
manufacturerCode: string
Maximum Length:
30
Display the manufacturer of the asset.Example:WD-ABCElectronics
-
manufacturerPartNumber: string
Maximum Length:
60
A number that uniquely identifies the manufacturer partExample:4.978284
Nested Schema : items
Type:
Show Source
object
-
vendorLocationExternalId: string
Maximum Length:
60
External IDExample:WD-AGMElectronics
-
vendorLocationId: string
Maximum Length:
12
One or many vendor locations are defined for each vendor to distinguish between multiple vendor sites. Each location provides more detailed information about the vendor site such as an address, capabilities, payment details, contacts, and so on.Example:000123456789
-
vendorPartNumber: string
Maximum Length:
60
A number that uniquely identifies the supplier part.Example:5.76382
-
vendorPriority: string
Allowed Values:
[ "W1OT", "W1PR" ]
Used to denote which is the primary supplier of the item. At least one vendor must be set as primary.Example:W1PR
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.