Jump to

• Request
• Response

Manage Stock Item Detail

post

https://server:port/rest/apis/asset/inventory/stockItemDetail/

Creates or updates Stock Item Detail records.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  A unique identifier of the record as represented in the external system.

  Example: 300001230554550
• externalSystem: string
  Maximum Length: 30

  The Work and Asset Management code that represents the external system.

  Example: ERP
• inventory: object inventory
• purchaseToIssueRatio: number
  Minimum Value: 0

  Maximum Value: 99999999

  Number representing the relationship between the Unit of Purchase and the Unit of Issue. This ratio can be used to determine the number of units issued from each unit purchased.

  Example: 1
• status: string
  Maximum Length: 12

  The current status of the Stock Item Detail.

  Example: ACTIVE
• stockItemDetailClass: string
  Allowed Values: [ "W1DP", "W1ER", "W1IL", "W1IN", "W1IT", "W1SD", "W1SL" ]

  Stock Item Detail Class * `W1DP` - Direct Purchase, * `W1ER` - Expensed at Receipt, * `W1IL` - Inventory Lot Managed, * `W1IN` - Inventory, * `W1IT` - Inventory Tracked, * `W1SD` - Specific Direct Purchase, * `W1SL` - Specific Lot

  Example: W1IN
• stockItemDetailId: string
  Maximum Length: 12

  System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.

  Example: 815404563965
• stockItemExternalId: string
  Maximum Length: 60

  Unique identification of the Stock Item in the external system.

  Example: 500000228404042
• storeroomExternalId: string
  Maximum Length: 60

  Unique identification of the Storeroom in the external system.

  Example: 300000058336894
• unitOfIssue: string
  Maximum Length: 30

  Defines the type of unit used to issue item from the storeroom.

  Example: EACH
• unitOfPurchase: string
  Maximum Length: 30

  Defines the type of unit used to when purchasing items to replenish inventory to the storeroom.

  Example: BOX

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":"30",
            "description":"The Work and Asset Management code that represents the external system.",
            "example":"ERP"
        },
        "externalId":{
            "type":"string",
            "maxLength":"60",
            "description":"A unique identifier of the record as represented in the external system.",
            "example":"300001230554550"
        },
        "stockItemDetailId":{
            "type":"string",
            "maxLength":"12",
            "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.",
            "example":"815404563965"
        },
        "stockItemExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Unique identification of the Stock Item in the external system.",
            "example":"500000228404042"
        },
        "storeroomExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Unique identification of the Storeroom in the external system.",
            "example":"300000058336894"
        },
        "stockItemDetailClass":{
            "type":"string",
            "enum":[
                "W1DP",
                "W1ER",
                "W1IL",
                "W1IN",
                "W1IT",
                "W1SD",
                "W1SL"
            ],
            "description":"Stock Item Detail Class\n* `W1DP` - Direct Purchase,\n* `W1ER` - Expensed at Receipt,\n* `W1IL` - Inventory Lot Managed,\n* `W1IN` - Inventory,\n* `W1IT` - Inventory Tracked,\n* `W1SD` - Specific Direct Purchase,\n* `W1SL` - Specific Lot",
            "example":"W1IN"
        },
        "status":{
            "type":"string",
            "maxLength":"12",
            "description":"The current status of the Stock Item Detail.",
            "example":"ACTIVE"
        },
        "unitOfPurchase":{
            "type":"string",
            "maxLength":"30",
            "description":"Defines the type of unit used to when purchasing items to replenish inventory to the storeroom.",
            "example":"BOX"
        },
        "unitOfIssue":{
            "type":"string",
            "maxLength":"30",
            "description":"Defines the type of unit used to issue item from the storeroom.",
            "example":"EACH"
        },
        "purchaseToIssueRatio":{
            "type":"number",
            "maximum":"99999999",
            "minimum":"0",
            "description":"Number representing the relationship between the Unit of Purchase and the Unit of Issue. This ratio can be used to determine the number of units issued from each unit purchased.",
            "example":"1"
        },
        "inventory":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                }
            }
        }
    },
    "xml":{
        "name":"W1ProcSID"
    }
}

Nested Schema : inventory

Type: object

Show Source

• segment1: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment10: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment2: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment3: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment4: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment5: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment6: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment7: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment8: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment9: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012

{
    "type":"object",
    "properties":{
        "segment1":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment2":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment3":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment4":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment5":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment6":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment7":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment8":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment9":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment10":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  A unique identifier of the record as represented in the external system.

  Example: 300001230554550
• externalSystem: string
  Maximum Length: 30

  The Work and Asset Management code that represents the external system.

  Example: ERP
• inventory: object inventory
• purchaseToIssueRatio: number
  Minimum Value: 0

  Maximum Value: 99999999

  Number representing the relationship between the Unit of Purchase and the Unit of Issue. This ratio can be used to determine the number of units issued from each unit purchased.

  Example: 1
• status: string
  Maximum Length: 12

  The current status of the Stock Item Detail.

  Example: ACTIVE
• stockItemDetailClass: string
  Allowed Values: [ "W1DP", "W1ER", "W1IL", "W1IN", "W1IT", "W1SD", "W1SL" ]

  Stock Item Detail Class * `W1DP` - Direct Purchase, * `W1ER` - Expensed at Receipt, * `W1IL` - Inventory Lot Managed, * `W1IN` - Inventory, * `W1IT` - Inventory Tracked, * `W1SD` - Specific Direct Purchase, * `W1SL` - Specific Lot

  Example: W1IN
• stockItemDetailId: string
  Maximum Length: 12

  System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.

  Example: 815404563965
• stockItemExternalId: string
  Maximum Length: 60

  Unique identification of the Stock Item in the external system.

  Example: 500000228404042
• storeroomExternalId: string
  Maximum Length: 60

  Unique identification of the Storeroom in the external system.

  Example: 300000058336894
• unitOfIssue: string
  Maximum Length: 30

  Defines the type of unit used to issue item from the storeroom.

  Example: EACH
• unitOfPurchase: string
  Maximum Length: 30

  Defines the type of unit used to when purchasing items to replenish inventory to the storeroom.

  Example: BOX

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":"30",
            "description":"The Work and Asset Management code that represents the external system.",
            "example":"ERP"
        },
        "externalId":{
            "type":"string",
            "maxLength":"60",
            "description":"A unique identifier of the record as represented in the external system.",
            "example":"300001230554550"
        },
        "stockItemDetailId":{
            "type":"string",
            "maxLength":"12",
            "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.",
            "example":"815404563965"
        },
        "stockItemExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Unique identification of the Stock Item in the external system.",
            "example":"500000228404042"
        },
        "storeroomExternalId":{
            "type":"string",
            "maxLength":"60",
            "description":"Unique identification of the Storeroom in the external system.",
            "example":"300000058336894"
        },
        "stockItemDetailClass":{
            "type":"string",
            "enum":[
                "W1DP",
                "W1ER",
                "W1IL",
                "W1IN",
                "W1IT",
                "W1SD",
                "W1SL"
            ],
            "description":"Stock Item Detail Class\n* `W1DP` - Direct Purchase,\n* `W1ER` - Expensed at Receipt,\n* `W1IL` - Inventory Lot Managed,\n* `W1IN` - Inventory,\n* `W1IT` - Inventory Tracked,\n* `W1SD` - Specific Direct Purchase,\n* `W1SL` - Specific Lot",
            "example":"W1IN"
        },
        "status":{
            "type":"string",
            "maxLength":"12",
            "description":"The current status of the Stock Item Detail.",
            "example":"ACTIVE"
        },
        "unitOfPurchase":{
            "type":"string",
            "maxLength":"30",
            "description":"Defines the type of unit used to when purchasing items to replenish inventory to the storeroom.",
            "example":"BOX"
        },
        "unitOfIssue":{
            "type":"string",
            "maxLength":"30",
            "description":"Defines the type of unit used to issue item from the storeroom.",
            "example":"EACH"
        },
        "purchaseToIssueRatio":{
            "type":"number",
            "maximum":"99999999",
            "minimum":"0",
            "description":"Number representing the relationship between the Unit of Purchase and the Unit of Issue. This ratio can be used to determine the number of units issued from each unit purchased.",
            "example":"1"
        },
        "inventory":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"012"
                }
            }
        }
    },
    "xml":{
        "name":"W1ProcSID"
    }
}

Nested Schema : inventory

Type: object

Show Source

• segment1: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment10: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment2: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment3: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment4: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment5: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment6: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment7: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment8: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012
• segment9: string
  Maximum Length: 254

  Enterprise Resource Planning Account Segment.

  Example: 012

{
    "type":"object",
    "properties":{
        "segment1":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment2":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment3":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment4":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment5":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment6":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment7":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment8":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment9":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        },
        "segment10":{
            "type":"string",
            "maxLength":"254",
            "description":"Enterprise Resource Planning Account Segment.",
            "example":"012"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : W1ProcSID

Type: object

Show Source

• externalId: string
  Maximum Length: 60

  A unique identifier of the record as represented in the external system.

  Example: 300001230554550
• stockItemDetailId: string
  Maximum Length: 12

  System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.

  Example: 815404563965

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":"60",
            "description":"A unique identifier of the record as represented in the external system.",
            "example":"300001230554550"
        },
        "stockItemDetailId":{
            "type":"string",
            "maxLength":"12",
            "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.",
            "example":"815404563965"
        }
    },
    "xml":{
        "name":"W1ProcSID"
    }
}

400 Response

Bad Request

Body ()

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