Oracle Utilities REST API for Work and Asset

Manage Storeroom

post

https://server:port/rest/apis/asset/storeroom/

Creates or updates storerooms.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

category: string

Allowed Values: [ "W1ST", "W1TR", "W1UN" ]

Storeroom Category * `W1ST` - Standard, * `W1TR` - Truck, * `W1UN` - Unmanned

Example: W1ST
description: string

Maximum Length: 100

Brief description up to 100 characters for the storeroom.

Example: Main Storeroom A
externalId: string

Maximum Length: 60

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

Example: 300000058336894
externalSystem: string

Maximum Length: 30

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

Example: ERP
inventory: object inventory
inventoryAdjustment: object inventoryAdjustment
invoiceWriteOff: object invoiceWriteOff
location: object location
markup: object markup
status: string

Allowed Values: [ "W1AC", "W1IA" ]

Location Disposition: * `W1AC` - Active, * `W1IA` - Inactive
stockTransferClearing: object stockTransferClearing
storeroomId: string

Maximum Length: 12

System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.

Example: 006972495096
taxAccountSegment: object taxAccountSegment
timeZone: string

Maximum Length: 10

Time Zone of the storeroom address.

Example: USPACIFIC

{
    "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":"300000058336894"
        },
        "storeroomId":{
            "type":"string",
            "maxLength":"12",
            "description":"System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.",
            "example":"006972495096"
        },
        "category":{
            "type":"string",
            "enum":[
                "W1ST",
                "W1TR",
                "W1UN"
            ],
            "description":"Storeroom Category\n* `W1ST` - Standard,\n* `W1TR` - Truck,\n* `W1UN` - Unmanned",
            "example":"W1ST"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the storeroom.",
            "example":"Main Storeroom A"
        },
        "status":{
            "type":"string",
            "enum":[
                "W1AC",
                "W1IA"
            ],
            "description":"Location Disposition:\n* `W1AC` - Active,\n* `W1IA` - Inactive"
        },
        "location":{
            "type":"object",
            "properties":{
                "address1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The first line for the address, associated with the storeroom.",
                    "example":"475 Sansome Street"
                },
                "address2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The second line for the address, associated with the storeroom.",
                    "example":"#15"
                },
                "address3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The third line for the address, associated with the storeroom.",
                    "example":"Building A"
                },
                "address4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The fourth line for the address, associated with the storeroom.",
                    "example":"Suite 101"
                },
                "crossStreet":{
                    "type":"string",
                    "maxLength":"64",
                    "description":"The Cross Street the PO address.",
                    "example":"First Street"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"House Type:\n"
                },
                "number1":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"Storeroom street number 1.",
                    "example":"1400"
                },
                "number2":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Storeroom street number 2.",
                    "example":"Building 2"
                },
                "geographicCode":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"The Geographic Code for the storeroom address.",
                    "example":"215"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"Indicates if the storeroom address is within the city boundary.",
                    "example":"Yes"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The City for the storeroom address.",
                    "example":"San Francisco"
                },
                "suburb":{
                    "type":"string",
                    "maxLength":"64",
                    "description":"The Suburb for the storeroom address.",
                    "example":"Park Ridge"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"County of the storeroom address.",
                    "example":"Alameda"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"State of the storeroom address.",
                    "example":"CA"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"The Postal Code for the storeroom address.",
                    "example":"94111"
                },
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"The Country Code for the storeroom address.",
                    "example":"USA"
                },
                "locationClass":{
                    "type":"string",
                    "enum":[
                        "W1NA"
                    ],
                    "description":"Location Class\n* `W1NA` - Not Applicable",
                    "example":"W1NA"
                }
            }
        },
        "timeZone":{
            "type":"string",
            "maxLength":"10",
            "description":"Time Zone of the storeroom address.",
            "example":"USPACIFIC"
        },
        "inventory":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "inventoryAdjustment":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "markup":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "stockTransferClearing":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "taxAccountSegment":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "invoiceWriteOff":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        }
    },
    "xml":{
        "name":"W1ProcStrm"
    }
}

Nested Schema : inventory

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : inventoryAdjustment

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : invoiceWriteOff

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : location

Type: object

Show Source

address1: string

Maximum Length: 254

The first line for the address, associated with the storeroom.

Example: 475 Sansome Street
address2: string

Maximum Length: 254

The second line for the address, associated with the storeroom.

Example: #15
address3: string

Maximum Length: 254

The third line for the address, associated with the storeroom.

Example: Building A
address4: string

Maximum Length: 254

The fourth line for the address, associated with the storeroom.

Example: Suite 101
city: string

Maximum Length: 90

The City for the storeroom address.

Example: San Francisco
country: string

Maximum Length: 3

The Country Code for the storeroom address.

Example: USA
county: string

Maximum Length: 90

County of the storeroom address.

Example: Alameda
crossStreet: string

Maximum Length: 64

The Cross Street the PO address.

Example: First Street
geographicCode: string

Maximum Length: 11

The Geographic Code for the storeroom address.

Example: 215
houseType: string

House Type:
inCityLimit: boolean

Indicates if the storeroom address is within the city boundary.

Example: Yes
locationClass: string

Allowed Values: [ "W1NA" ]

Location Class * `W1NA` - Not Applicable

Example: W1NA
number1: string

Maximum Length: 6

Storeroom street number 1.

Example: 1400
number2: string

Maximum Length: 4

Storeroom street number 2.

Example: Building 2
postal: string

Maximum Length: 12

The Postal Code for the storeroom address.

Example: 94111
state: string

Maximum Length: 6

State of the storeroom address.

Example: CA
suburb: string

Maximum Length: 64

The Suburb for the storeroom address.

Example: Park Ridge

{
    "type":"object",
    "properties":{
        "address1":{
            "type":"string",
            "maxLength":"254",
            "description":"The first line for the address, associated with the storeroom.",
            "example":"475 Sansome Street"
        },
        "address2":{
            "type":"string",
            "maxLength":"254",
            "description":"The second line for the address, associated with the storeroom.",
            "example":"#15"
        },
        "address3":{
            "type":"string",
            "maxLength":"254",
            "description":"The third line for the address, associated with the storeroom.",
            "example":"Building A"
        },
        "address4":{
            "type":"string",
            "maxLength":"254",
            "description":"The fourth line for the address, associated with the storeroom.",
            "example":"Suite 101"
        },
        "crossStreet":{
            "type":"string",
            "maxLength":"64",
            "description":"The Cross Street the PO address.",
            "example":"First Street"
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"House Type:\n"
        },
        "number1":{
            "type":"string",
            "maxLength":"6",
            "description":"Storeroom street number 1.",
            "example":"1400"
        },
        "number2":{
            "type":"string",
            "maxLength":"4",
            "description":"Storeroom street number 2.",
            "example":"Building 2"
        },
        "geographicCode":{
            "type":"string",
            "maxLength":"11",
            "description":"The Geographic Code for the storeroom address.",
            "example":"215"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"Indicates if the storeroom address is within the city boundary.",
            "example":"Yes"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"The City for the storeroom address.",
            "example":"San Francisco"
        },
        "suburb":{
            "type":"string",
            "maxLength":"64",
            "description":"The Suburb for the storeroom address.",
            "example":"Park Ridge"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"County of the storeroom address.",
            "example":"Alameda"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"State of the storeroom address.",
            "example":"CA"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"The Postal Code for the storeroom address.",
            "example":"94111"
        },
        "country":{
            "type":"string",
            "maxLength":"3",
            "description":"The Country Code for the storeroom address.",
            "example":"USA"
        },
        "locationClass":{
            "type":"string",
            "enum":[
                "W1NA"
            ],
            "description":"Location Class\n* `W1NA` - Not Applicable",
            "example":"W1NA"
        }
    }
}

Nested Schema : markup

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : stockTransferClearing

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : taxAccountSegment

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Root Schema : schema

Type: object

Show Source

category: string

Allowed Values: [ "W1ST", "W1TR", "W1UN" ]

Storeroom Category * `W1ST` - Standard, * `W1TR` - Truck, * `W1UN` - Unmanned

Example: W1ST
description: string

Maximum Length: 100

Brief description up to 100 characters for the storeroom.

Example: Main Storeroom A
externalId: string

Maximum Length: 60

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

Example: 300000058336894
externalSystem: string

Maximum Length: 30

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

Example: ERP
inventory: object inventory
inventoryAdjustment: object inventoryAdjustment
invoiceWriteOff: object invoiceWriteOff
location: object location
markup: object markup
status: string

Allowed Values: [ "W1AC", "W1IA" ]

Location Disposition: * `W1AC` - Active, * `W1IA` - Inactive
stockTransferClearing: object stockTransferClearing
storeroomId: string

Maximum Length: 12

System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.

Example: 006972495096
taxAccountSegment: object taxAccountSegment
timeZone: string

Maximum Length: 10

Time Zone of the storeroom address.

Example: USPACIFIC

{
    "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":"300000058336894"
        },
        "storeroomId":{
            "type":"string",
            "maxLength":"12",
            "description":"System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.",
            "example":"006972495096"
        },
        "category":{
            "type":"string",
            "enum":[
                "W1ST",
                "W1TR",
                "W1UN"
            ],
            "description":"Storeroom Category\n* `W1ST` - Standard,\n* `W1TR` - Truck,\n* `W1UN` - Unmanned",
            "example":"W1ST"
        },
        "description":{
            "type":"string",
            "maxLength":"100",
            "description":"Brief description up to 100 characters for the storeroom.",
            "example":"Main Storeroom A"
        },
        "status":{
            "type":"string",
            "enum":[
                "W1AC",
                "W1IA"
            ],
            "description":"Location Disposition:\n* `W1AC` - Active,\n* `W1IA` - Inactive"
        },
        "location":{
            "type":"object",
            "properties":{
                "address1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The first line for the address, associated with the storeroom.",
                    "example":"475 Sansome Street"
                },
                "address2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The second line for the address, associated with the storeroom.",
                    "example":"#15"
                },
                "address3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The third line for the address, associated with the storeroom.",
                    "example":"Building A"
                },
                "address4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"The fourth line for the address, associated with the storeroom.",
                    "example":"Suite 101"
                },
                "crossStreet":{
                    "type":"string",
                    "maxLength":"64",
                    "description":"The Cross Street the PO address.",
                    "example":"First Street"
                },
                "houseType":{
                    "type":"string",
                    "enum":[
                    ],
                    "description":"House Type:\n"
                },
                "number1":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"Storeroom street number 1.",
                    "example":"1400"
                },
                "number2":{
                    "type":"string",
                    "maxLength":"4",
                    "description":"Storeroom street number 2.",
                    "example":"Building 2"
                },
                "geographicCode":{
                    "type":"string",
                    "maxLength":"11",
                    "description":"The Geographic Code for the storeroom address.",
                    "example":"215"
                },
                "inCityLimit":{
                    "type":"boolean",
                    "description":"Indicates if the storeroom address is within the city boundary.",
                    "example":"Yes"
                },
                "city":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"The City for the storeroom address.",
                    "example":"San Francisco"
                },
                "suburb":{
                    "type":"string",
                    "maxLength":"64",
                    "description":"The Suburb for the storeroom address.",
                    "example":"Park Ridge"
                },
                "county":{
                    "type":"string",
                    "maxLength":"90",
                    "description":"County of the storeroom address.",
                    "example":"Alameda"
                },
                "state":{
                    "type":"string",
                    "maxLength":"6",
                    "description":"State of the storeroom address.",
                    "example":"CA"
                },
                "postal":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"The Postal Code for the storeroom address.",
                    "example":"94111"
                },
                "country":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"The Country Code for the storeroom address.",
                    "example":"USA"
                },
                "locationClass":{
                    "type":"string",
                    "enum":[
                        "W1NA"
                    ],
                    "description":"Location Class\n* `W1NA` - Not Applicable",
                    "example":"W1NA"
                }
            }
        },
        "timeZone":{
            "type":"string",
            "maxLength":"10",
            "description":"Time Zone of the storeroom address.",
            "example":"USPACIFIC"
        },
        "inventory":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "inventoryAdjustment":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "markup":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "stockTransferClearing":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "taxAccountSegment":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        },
        "invoiceWriteOff":{
            "type":"object",
            "properties":{
                "segment1":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment2":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment3":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment4":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment5":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment6":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment7":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment8":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment9":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                },
                "segment10":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Enterprise Resource Planning Account Segment.",
                    "example":"011"
                }
            }
        }
    },
    "xml":{
        "name":"W1ProcStrm"
    }
}

Nested Schema : inventory

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : inventoryAdjustment

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : invoiceWriteOff

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : location

Type: object

Show Source

address1: string

Maximum Length: 254

The first line for the address, associated with the storeroom.

Example: 475 Sansome Street
address2: string

Maximum Length: 254

The second line for the address, associated with the storeroom.

Example: #15
address3: string

Maximum Length: 254

The third line for the address, associated with the storeroom.

Example: Building A
address4: string

Maximum Length: 254

The fourth line for the address, associated with the storeroom.

Example: Suite 101
city: string

Maximum Length: 90

The City for the storeroom address.

Example: San Francisco
country: string

Maximum Length: 3

The Country Code for the storeroom address.

Example: USA
county: string

Maximum Length: 90

County of the storeroom address.

Example: Alameda
crossStreet: string

Maximum Length: 64

The Cross Street the PO address.

Example: First Street
geographicCode: string

Maximum Length: 11

The Geographic Code for the storeroom address.

Example: 215
houseType: string

House Type:
inCityLimit: boolean

Indicates if the storeroom address is within the city boundary.

Example: Yes
locationClass: string

Allowed Values: [ "W1NA" ]

Location Class * `W1NA` - Not Applicable

Example: W1NA
number1: string

Maximum Length: 6

Storeroom street number 1.

Example: 1400
number2: string

Maximum Length: 4

Storeroom street number 2.

Example: Building 2
postal: string

Maximum Length: 12

The Postal Code for the storeroom address.

Example: 94111
state: string

Maximum Length: 6

State of the storeroom address.

Example: CA
suburb: string

Maximum Length: 64

The Suburb for the storeroom address.

Example: Park Ridge

{
    "type":"object",
    "properties":{
        "address1":{
            "type":"string",
            "maxLength":"254",
            "description":"The first line for the address, associated with the storeroom.",
            "example":"475 Sansome Street"
        },
        "address2":{
            "type":"string",
            "maxLength":"254",
            "description":"The second line for the address, associated with the storeroom.",
            "example":"#15"
        },
        "address3":{
            "type":"string",
            "maxLength":"254",
            "description":"The third line for the address, associated with the storeroom.",
            "example":"Building A"
        },
        "address4":{
            "type":"string",
            "maxLength":"254",
            "description":"The fourth line for the address, associated with the storeroom.",
            "example":"Suite 101"
        },
        "crossStreet":{
            "type":"string",
            "maxLength":"64",
            "description":"The Cross Street the PO address.",
            "example":"First Street"
        },
        "houseType":{
            "type":"string",
            "enum":[
            ],
            "description":"House Type:\n"
        },
        "number1":{
            "type":"string",
            "maxLength":"6",
            "description":"Storeroom street number 1.",
            "example":"1400"
        },
        "number2":{
            "type":"string",
            "maxLength":"4",
            "description":"Storeroom street number 2.",
            "example":"Building 2"
        },
        "geographicCode":{
            "type":"string",
            "maxLength":"11",
            "description":"The Geographic Code for the storeroom address.",
            "example":"215"
        },
        "inCityLimit":{
            "type":"boolean",
            "description":"Indicates if the storeroom address is within the city boundary.",
            "example":"Yes"
        },
        "city":{
            "type":"string",
            "maxLength":"90",
            "description":"The City for the storeroom address.",
            "example":"San Francisco"
        },
        "suburb":{
            "type":"string",
            "maxLength":"64",
            "description":"The Suburb for the storeroom address.",
            "example":"Park Ridge"
        },
        "county":{
            "type":"string",
            "maxLength":"90",
            "description":"County of the storeroom address.",
            "example":"Alameda"
        },
        "state":{
            "type":"string",
            "maxLength":"6",
            "description":"State of the storeroom address.",
            "example":"CA"
        },
        "postal":{
            "type":"string",
            "maxLength":"12",
            "description":"The Postal Code for the storeroom address.",
            "example":"94111"
        },
        "country":{
            "type":"string",
            "maxLength":"3",
            "description":"The Country Code for the storeroom address.",
            "example":"USA"
        },
        "locationClass":{
            "type":"string",
            "enum":[
                "W1NA"
            ],
            "description":"Location Class\n* `W1NA` - Not Applicable",
            "example":"W1NA"
        }
    }
}

Nested Schema : markup

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : stockTransferClearing

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Nested Schema : taxAccountSegment

Type: object

Show Source

segment1: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment10: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment2: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment3: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment4: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment5: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment6: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment7: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment8: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011
segment9: string

Maximum Length: 254

Enterprise Resource Planning Account Segment.

Example: 011

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

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : W1ProcStrm

Type: object

Show Source

externalId: string

Maximum Length: 60

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

Example: 300000058336894
storeroomId: string

Maximum Length: 12

System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.

Example: 006972495096

{
    "type":"object",
    "properties":{
        "externalId":{
            "type":"string",
            "maxLength":"60",
            "description":"A unique identifier of the record as represented in the external system.",
            "example":"300000058336894"
        },
        "storeroomId":{
            "type":"string",
            "maxLength":"12",
            "description":"System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.",
            "example":"006972495096"
        }
    },
    "xml":{
        "name":"W1ProcStrm"
    }
}

400 Response

Bad Request

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

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."
        }
    }
}