Get one item supply information
get
/fscmRestApi/resources/11.13.18.05/availableSupplies/{UniqueOrderId}/child/SupplyAvailabilityDetails/{SupplyAvailabilityDetailsUniqID}
Request
Path Parameters
-
SupplyAvailabilityDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- UniqueorderId and Itemid ---for the Supply Availability Details resource and used to uniquely identify an instance of Supply Availability Details. The client should not generate the hash key value. Instead, the client should query on the Supply Availability Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Supply Availability Details.
For example: SupplyAvailabilityDetails?q=UniqueorderId=<value1>;Itemid=<value2> -
UniqueOrderId(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : availableSupplies-SupplyAvailabilityDetails-item-response
Type:
Show Source
object
-
Availablequantity: number
Difference between the shelf quantity and the supply quantity that's already allocated to demands.
-
Consumedquantity: number
Quantity of the available to promise inventory consumed by both the independent and dependent demands.
-
Cumulativequantity: number
Available-to-promise quantity that's accumulated from the horizon start date and is adjusted after considering the net quantity.
-
Effectivedate: string
(date)
Date for which the daily availability information is returned.
-
Errorcode: string
Maximum Length:
20
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the supply availability request. -
Errormessage: string
Maximum Length:
20
Text of the error message, if any, for the error code. -
Getavailfordropshipsuppierflag: string
Maximum Length:
255
This attribute isn't currently used. -
Getavailforsubstituteitems: string
Maximum Length:
255
Binary attribute that determines whether availability of substitute items should be considered or not. -
InternalSalesOrderDestOrg: string
Maximum Length:
255
Abbreviation that identifies the organization that represents the destination of supply, for transfer of supply. -
Itemid: string
Maximum Length:
255
Value that uniquely identifies an item. -
Lineid: number
Value that uniquely identifies the order line.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Netquantity: number
Difference between supply quantity and consumed quantity.
-
Organizationid: string
Maximum Length:
255
Value that uniquely identifies an organization. -
Partyid: string
Maximum Length:
255
Value that uniquely identifies the party representing the customer. -
Partysiteid: string
Maximum Length:
255
Value that uniquely identifies the party site representing the customer site. -
Region: string
Maximum Length:
255
Value that uniquely identifies the region from which material is to be shipped to the customer ship-to site. -
Requesteddate: string
(date-time)
Date when the material is checked for availability. This attribute specifies the date until when the resource availability information needs to be returned.
-
Resourcename: string
Maximum Length:
255
Name of the resource for which availability information is requested. -
Shelfquantity: number
Supply quantity at the organization or supplier location.
-
Supplierid: string
Maximum Length:
255
Value that uniquely identifies a supplier. -
Suppliersiteid: string
Maximum Length:
255
Value that uniquely identifies a supplier site. -
Supplyquantity: number
Quantity of supply on a particular date.
-
UniqueorderId: string
Maximum Length:
255
Value that uniquely identifies the supply details for the available supply. -
Workarea: string
Maximum Length:
255
Value that identifies the work area to which the resource belongs. -
Workcenter: string
Maximum Length:
255
Value that identifies the work center to which the resource belongs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.