Create results for availability
post
/fscmRestApi/resources/11.13.18.05/availableSupplies
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CallingInstance: string
Maximum Length:
255
Value that uniquely identifies the source application from which the order promising service request originated. -
CallingModule: string
Maximum Length:
255
Value that identifies the module from which the order promising service request originated. -
EndDate: string
(date)
Date until when the supply availability information is returned. This attribute is the end date of the supply availability request date range.
-
ErrorCode: string
Maximum Length:
255
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the supply availability request. -
OperationName: string
Maximum Length:
255
Value that indicates the type of request that needs to be performed for the fulfillment line. -
PromiseDate: string
(date)
Date and time when the promise is generated by Oracle Global Order Promising Cloud.
-
PromisingSystem: string
Maximum Length:
255
Value that identifies the order promising application that performed the availability check. -
QueryId: string
Maximum Length:
255
Value that uniquely identifies the order promising web service query. -
RequestCreationDate: string
(date)
Date when the supply availability request was created.
-
StartDate: string
(date)
Date from when the supply availability information is returned. This attribute is the start date of the supply availability request date range.
-
SupplyAvailabilityDetails: array
Supply Availability Details
Title:
Supply Availability Details
The Supply Availability Details resource manages supply check for an item at one or more organizations, as well as availability check for manufacturing resource or supplier, in a specified time window. -
UniqueOrderId: string
Maximum Length:
255
Value that uniquely identifies the order for the request.
Nested Schema : Supply Availability Details
Type:
array
Title:
Supply Availability Details
The Supply Availability Details resource manages supply check for an item at one or more organizations, as well as availability check for manufacturing resource or supplier, in a specified time window.
Show Source
Nested Schema : availableSupplies-SupplyAvailabilityDetails-item-post-request
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.
-
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-item-response
Type:
Show Source
object
-
CallingInstance: string
Maximum Length:
255
Value that uniquely identifies the source application from which the order promising service request originated. -
CallingModule: string
Maximum Length:
255
Value that identifies the module from which the order promising service request originated. -
EndDate: string
(date)
Date until when the supply availability information is returned. This attribute is the end date of the supply availability request date range.
-
ErrorCode: string
Maximum Length:
255
Abbreviation that identifies the error code, if any, returned by Oracle Global Order Promising Cloud for the supply availability request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Maximum Length:
255
Value that indicates the type of request that needs to be performed for the fulfillment line. -
PromiseDate: string
(date)
Date and time when the promise is generated by Oracle Global Order Promising Cloud.
-
PromisingSystem: string
Maximum Length:
255
Value that identifies the order promising application that performed the availability check. -
QueryId: string
Maximum Length:
255
Value that uniquely identifies the order promising web service query. -
RequestCreationDate: string
(date)
Date when the supply availability request was created.
-
StartDate: string
(date)
Date from when the supply availability information is returned. This attribute is the start date of the supply availability request date range.
-
SupplyAvailabilityDetails: array
Supply Availability Details
Title:
Supply Availability Details
The Supply Availability Details resource manages supply check for an item at one or more organizations, as well as availability check for manufacturing resource or supplier, in a specified time window. -
UniqueOrderId: string
Maximum Length:
255
Value that uniquely identifies the order for the request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Supply Availability Details
Type:
array
Title:
Supply Availability Details
The Supply Availability Details resource manages supply check for an item at one or more organizations, as well as availability check for manufacturing resource or supplier, in a specified time window.
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.
Nested 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
Links
- SupplyAvailabilityDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/availableSupplies/{UniqueOrderId}/child/SupplyAvailabilityDetailsParameters:
- UniqueOrderId:
$request.path.UniqueOrderId
The Supply Availability Details resource manages supply check for an item at one or more organizations, as well as availability check for manufacturing resource or supplier, in a specified time window. - UniqueOrderId:
Examples
This example describes how to create results for availability.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.batch+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "parts":[ { "id":"Request", "path":"/availableSupplies", "operation":"create", "payload":{ "CallingModule": "GOP", "CallingInstance": "100010026240309", "RequestCreationDate":"2017-01-01", "OperationName": "quickAvailability", "SupplyAvailabilityDetails" : [ { "Itemid" : "11593", "Requesteddate" :"2019-03-12" } ] } } ] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "parts": [ { "id": "Request", "path": "https://servername/fscmRestApi/resources/version/availableSupplies", "operation": "create", "payload": { "UniqueOrderId": "205", "CallingModule": "GOP", "CallingInstance": "100010026240309", "QueryId": null, "StartDate": null, "EndDate": null, "RequestCreationDate": "2017-01-01", "PromisingSystem": "DOO-OP", "PromiseDate": null, "ErrorCode": "null", "OperationName": "quickAvailability", "SupplyAvailabilityDetails": [ {} ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/availableSupplies/205", "name": "availableSupplies", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/availableSupplies/205", "name": "availableSupplies", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/availableSupplies/205/child/SupplyAvailabilityDetails", "name": "SupplyAvailabilityDetails", "kind": "collection" } ] } } ] }