Create a recall subinventory
post
/fscmRestApi/resources/11.13.18.05/recallSubinventories
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
InventoryOrganizationCode: string
Title:
Inventory Organization
Maximum Length:18
Abbreviation that identifies the organization. -
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization for which the recall subinventory is set.
-
InventoryOrganizationName: string
Title:
Inventory Organization
Maximum Length:240
Name of the inventory organization. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ParameterValueId: integer
(int64)
Value that uniquely identifies the recall parameter value.
-
PickSubinventoryFlag: boolean
Maximum Length:
1000
Indicates whether the pick subinventory is required during recall count through the mobile application. -
StockLocator: string
Title:
Stock Locator
Maximum Length:255
Name of the stock locator. This value is the concatenated segment of the locator identifier belonging to recall subinventory. -
StockLocatorId: string
Maximum Length:
60
Value that uniquely identifies the stock locator belonging to recall subinventory required to be set up when the recall subinventory is locator controlled. -
Subinventory: string
Maximum Length:
4000
Name of the subinventory. The recall subinventory is a non-reservable, quantity-tracked subinventory where the located parts are moved after the count. This is required to be set up for product recall management.
Response
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 : recallSubinventories-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Login that the user used when updating the document. -
InventoryOrganizationCode: string
Title:
Inventory Organization
Maximum Length:18
Abbreviation that identifies the organization. -
InventoryOrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization for which the recall subinventory is set.
-
InventoryOrganizationName: string
Title:
Inventory Organization
Maximum Length:240
Name of the inventory organization. -
LastUpdateDate: string
(date-time)
Read Only:
true
User who most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date and time when the user created the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Date and time when the user most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version. This attribute is used for optimistic locking. The number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ParameterValueId: integer
(int64)
Value that uniquely identifies the recall parameter value.
-
PickSubinventoryFlag: boolean
Maximum Length:
1000
Indicates whether the pick subinventory is required during recall count through the mobile application. -
StockLocator: string
Title:
Stock Locator
Maximum Length:255
Name of the stock locator. This value is the concatenated segment of the locator identifier belonging to recall subinventory. -
StockLocatorId: string
Maximum Length:
60
Value that uniquely identifies the stock locator belonging to recall subinventory required to be set up when the recall subinventory is locator controlled. -
Subinventory: string
Maximum Length:
4000
Name of the subinventory. The recall subinventory is a non-reservable, quantity-tracked subinventory where the located parts are moved after the count. This is required to be set up for product recall management.
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.
Examples
This example describes how to create a recall subinventory.
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.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/recallSubinventories"
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.
{ "InventoryOrganizationName": "Vision General Hospital", "Subinventory": "Recall", "StockLocator": "R.1.1" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ParameterValueId": 300100228031551, "InventoryOrganizationId": 300100200296143, "InventoryOrganizationName": "Vision General Hospital", "InventoryOrganizationCode": "HC01", "Subinventory": "Recall", "StockLocatorId": "300100200355887", "StockLocator": "R.1.1", "CreatedBy": "IMPL_CONSULTANT", "LastUpdatedBy": "IMPL_CONSULTANT", "LastUpdateLogin": "AAE6108794B2249BE053D48DF50AD084", "CreationDate": "2020-07-28T03:58:39+00:00", "LastUpdateDate": "2020-07-28T03:58:39.117+00:00", "ObjectVersionNumber": 1, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/recallSubinventories/300100228031551", "name": "recallSubinventories", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/recallSubinventories/300100228031551", "name": "recallSubinventories", "kind": "item" } ] }