Object Inquiry

URL: "xxx.wms.ocs.oraclecloud.com/env_name/wms/api/entity/key/"

Method: Get

Initial WMS Version: 8.0.2

Overview

REST API developed to return a standardized output representation of the queried object.

Requirements

1. The entity specified in the URL is valid
2. A key was supplied
3. A single object was found for the entity and key

Assumptions

1. The existing Update Entity API will be combined with this new API differentiated by the HTTP method.
2. Supports an output format of XML (default) or JSON
3. Data will have empty tags trimmed by default (minimize = True)
4. Supported entities: order, item, company, iblpn, oblpn

Output Format

The requester may choose the returned format of the data by specifying it in the URL. Allowed formats are 'xml' and 'json'. The format is specified by adding "/.format" to the end of the URL, before any options parameters. XML is the default format if none is specified.

Examples:
* Default XML:   .../wms/api/entity/{entity}/{key}
* Output JSON: .../wms/api/entity/{entity}/{key}/.json
* Output XML:   .../wms/api/entity/{entity}/{key}/.xml
* With Additional Parameters: .../wms/api/entity/{entity}/{key}/.json?facility_code=ABC123&...

Table 1. URL Parameters

Argument Name	Function	Value
Entity	Type of Object Identifier	order/item/company/iblpn/oblpn
Key	Unique Identifying Key	Explained below

Table 2. Supported Entities

Name	Entity	Version
Order	order	8.0.2
Company	company	8.0.2
Item	item	8.0.2
Inbound LPN	iblpn	8.0.2
Outbound LPN	oblpn	8.0.2

Table 3. Unique key Value for each entity

Entity	Identifier Key
order	order_nbr
company	code
Item	item_code or item_barcode or item_alternate_code
Inbound LPN	container_nbr
Outbound LPN	container_nbr

Table 4. Request Arguments

Parameter	Description	Default
facility_code	Context Facility	Requesting user's default context
company_code	Context Company	Requesting user's default context
minimize	Trim data to remove empty nodes	True

Note: Since version 9.0.0, fields will be return based on the set up of following company parameters: max_allowed_wt_vol_dim_decimal_scale and max_allowed_qty_decimal_scale