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
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • 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
  • 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
  • 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
Nested Schema : output
Type: object
Show Source
Nested Schema : stockItemInfo
Type: object
Show Source
  • Maximum Length: 12
    Status of the item based on business object lifecycle.
    Example: Active
  • 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
  • Maximum Length: 30
    The highest level, or most general categorization of an item.
    Example: Mechanical Items
  • 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
  • Maximum Length: 30
    For each category, there is a unique list of Commodity Names.
    Example: Check Valve.
  • Minimum Value: 0
    Maximum Value: 0
    Commodity Size ID (number) provided by ERP
    Example: 12
  • Maximum Length: 30
    For each category and name combination, there is a unique list of Commodity Types.
    Example: High-pressure pneumatic check valve.
  • 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
  • Maximum Length: 100
    Brief description up to 100 characters for the stock item.
    Example: Residential Gas Meter
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates that you do not want the vendor to substitute the item with an alternate.
    Example: W1YS
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether the item may be hazardous in some way.
    Example: W1YS
  • Allowed Values: [ "ZZ01", "ZZCH", "ZZEL" ]
    Indicates the type of hazard for hazardous items.
    Example: GDAC
  • 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
  • Maximum Length: 4000
    Longer description up to 4000 characters for the stock item.
    Example: Meter, Flow, FMU861, Endress-Hauser
  • Allowed Values: [ "W1NO", "W1YS" ]
    Lot Managed: * `W1NO` - No, * `W1YS` - Yes
    Example: W1YS
  • manufacturers
  • 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
  • Maximum Length: 30
    The commodity classification for the stock item.
    Example: Mechanical
  • 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
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether or not the item is eligible to be repaired, should it fail.
    Example: W1YS
  • Maximum Length: 60
    External ID
    Example: 300000228404035
  • 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
  • Maximum Length: 30
    Additional information about why a stock item transitioned to a new status.
    Example:
  • Allowed Values: [ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ]
    Categorization for stock items based on your organization's business practices.
    Example: WDBE
  • Maximum Length: 60
    The unique record IDs of the stock item, used as the stock code in Work and Asset Management.
    Example: 0000001
  • 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:
  • 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
  • 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
  • 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
  • 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
  • Maximum Length: 30
    Indicates the expense code that will be charged for costs related to the stock item being utilized.
    Example: WD-Inventory
  • vendors
Nested Schema : manufacturers
Type: object
Show Source
Nested Schema : vendors
Type: object
Show Source
Nested Schema : manufacturersList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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 BOM
    Example: 000123456789
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.
    Example: W1YS
  • Maximum Length: 30
    Display the manufacturer of the asset.
    Example: WD-ABCElectronics
  • Maximum Length: 60
    A number that uniquely identifies the manufacturer part
    Example: 4.978284
Nested Schema : vendorsList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 60
    External ID
    Example: WD-AGMElectronics
  • 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
  • Maximum Length: 60
    A number that uniquely identifies the supplier part.
    Example: 5.76382
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • 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
  • 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
  • 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
Nested Schema : output
Type: object
Show Source
Nested Schema : stockItemInfo
Type: object
Show Source
  • Maximum Length: 12
    Status of the item based on business object lifecycle.
    Example: Active
  • 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
  • Maximum Length: 30
    The highest level, or most general categorization of an item.
    Example: Mechanical Items
  • 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
  • Maximum Length: 30
    For each category, there is a unique list of Commodity Names.
    Example: Check Valve.
  • Minimum Value: 0
    Maximum Value: 0
    Commodity Size ID (number) provided by ERP
    Example: 12
  • Maximum Length: 30
    For each category and name combination, there is a unique list of Commodity Types.
    Example: High-pressure pneumatic check valve.
  • 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
  • Maximum Length: 100
    Brief description up to 100 characters for the stock item.
    Example: Residential Gas Meter
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates that you do not want the vendor to substitute the item with an alternate.
    Example: W1YS
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether the item may be hazardous in some way.
    Example: W1YS
  • Allowed Values: [ "ZZ01", "ZZCH", "ZZEL" ]
    Indicates the type of hazard for hazardous items.
    Example: GDAC
  • 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
  • Maximum Length: 4000
    Longer description up to 4000 characters for the stock item.
    Example: Meter, Flow, FMU861, Endress-Hauser
  • Allowed Values: [ "W1NO", "W1YS" ]
    Lot Managed: * `W1NO` - No, * `W1YS` - Yes
    Example: W1YS
  • manufacturers
  • 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
  • Maximum Length: 30
    The commodity classification for the stock item.
    Example: Mechanical
  • 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
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether or not the item is eligible to be repaired, should it fail.
    Example: W1YS
  • Maximum Length: 60
    External ID
    Example: 300000228404035
  • 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
  • Maximum Length: 30
    Additional information about why a stock item transitioned to a new status.
    Example:
  • Allowed Values: [ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ]
    Categorization for stock items based on your organization's business practices.
    Example: WDBE
  • Maximum Length: 60
    The unique record IDs of the stock item, used as the stock code in Work and Asset Management.
    Example: 0000001
  • 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:
  • 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
  • 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
  • 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
  • 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
  • Maximum Length: 30
    Indicates the expense code that will be charged for costs related to the stock item being utilized.
    Example: WD-Inventory
  • vendors
Nested Schema : manufacturers
Type: object
Show Source
Nested Schema : vendors
Type: object
Show Source
Nested Schema : manufacturersList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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 BOM
    Example: 000123456789
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.
    Example: W1YS
  • Maximum Length: 30
    Display the manufacturer of the asset.
    Example: WD-ABCElectronics
  • Maximum Length: 60
    A number that uniquely identifies the manufacturer part
    Example: 4.978284
Nested Schema : vendorsList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 60
    External ID
    Example: WD-AGMElectronics
  • 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
  • Maximum Length: 60
    A number that uniquely identifies the supplier part.
    Example: 5.76382
  • 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
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : W1AdStkItmSy_response
Type: object
Show Source
Nested Schema : W1AdStkItmSy
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • 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
  • 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
  • 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
Nested Schema : output
Type: object
Show Source
Nested Schema : stockItemInfo
Type: object
Show Source
  • Maximum Length: 12
    Status of the item based on business object lifecycle.
    Example: Active
  • 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
  • Maximum Length: 30
    The highest level, or most general categorization of an item.
    Example: Mechanical Items
  • 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
  • Maximum Length: 30
    For each category, there is a unique list of Commodity Names.
    Example: Check Valve.
  • Minimum Value: 0
    Maximum Value: 0
    Commodity Size ID (number) provided by ERP
    Example: 12
  • Maximum Length: 30
    For each category and name combination, there is a unique list of Commodity Types.
    Example: High-pressure pneumatic check valve.
  • 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
  • Maximum Length: 100
    Brief description up to 100 characters for the stock item.
    Example: Residential Gas Meter
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates that you do not want the vendor to substitute the item with an alternate.
    Example: W1YS
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether the item may be hazardous in some way.
    Example: W1YS
  • Allowed Values: [ "ZZ01", "ZZCH", "ZZEL" ]
    Indicates the type of hazard for hazardous items.
    Example: GDAC
  • 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
  • Maximum Length: 4000
    Longer description up to 4000 characters for the stock item.
    Example: Meter, Flow, FMU861, Endress-Hauser
  • Allowed Values: [ "W1NO", "W1YS" ]
    Lot Managed: * `W1NO` - No, * `W1YS` - Yes
    Example: W1YS
  • manufacturers
  • 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
  • Maximum Length: 30
    The commodity classification for the stock item.
    Example: Mechanical
  • 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
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether or not the item is eligible to be repaired, should it fail.
    Example: W1YS
  • Maximum Length: 60
    External ID
    Example: 300000228404035
  • 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
  • Maximum Length: 30
    Additional information about why a stock item transitioned to a new status.
    Example:
  • Allowed Values: [ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ]
    Categorization for stock items based on your organization's business practices.
    Example: WDBE
  • Maximum Length: 60
    The unique record IDs of the stock item, used as the stock code in Work and Asset Management.
    Example: 0000001
  • 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:
  • 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
  • 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
  • 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
  • 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
  • Maximum Length: 30
    Indicates the expense code that will be charged for costs related to the stock item being utilized.
    Example: WD-Inventory
  • vendors
Nested Schema : manufacturers
Type: object
Show Source
Nested Schema : vendors
Type: object
Show Source
Nested Schema : manufacturersList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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 BOM
    Example: 000123456789
  • Allowed Values: [ "W1NO", "W1YS" ]
    Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.
    Example: W1YS
  • Maximum Length: 30
    Display the manufacturer of the asset.
    Example: WD-ABCElectronics
  • Maximum Length: 60
    A number that uniquely identifies the manufacturer part
    Example: 4.978284
Nested Schema : vendorsList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 60
    External ID
    Example: WD-AGMElectronics
  • 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
  • Maximum Length: 60
    A number that uniquely identifies the supplier part.
    Example: 5.76382
  • 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
Body ()
Root Schema : W1AdStkItmSy_error
Type: object
Show Source
Nested Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : W1AdStkItmSy_error
Type: object
Show Source
Nested Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top