Create groups
/fscmRestApi/resources/11.13.18.05/inventoryReplenishRequests
Request
-
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.
- application/json
object
-
FailedRecordsCount: integer
Value that specifies the number of failed records.
-
replenishRequestLines: array
Request Lines
Title:
Request Lines
The Request Lines resource manages the replenish request lines. -
ReturnMessageCode: string
Abbreviation that identifies the response message.
-
ReturnMessageText: string
Text of the response message.
-
ReturnStatus: string
Status of the current service call.
-
SubmitForProcessing: string
Contains Yes or No. Yes: process the balance records. No: do not process the records. The default value is No.
-
SuccessRecordsCount: integer
Value that specifies the number of successful records.
-
TotalRecordsCount: integer
Value that specifies the total number of records.
-
UserName: string
Maximum Length:
64
Name of the user who requested the inventory replenishment.
array
Request Lines
object
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemNumber: string
Title:
Item
Maximum Length:300
Number that uniquely identifies the item. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Title:
Locator
Maximum Length:255
Name of the locator. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OverrideReplenishCountType: string
Type of override replenish count for the request.
-
OverrideReplenishCountTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of override replenish count for the request. -
Quantity: number
Title:
Quantity
Quantity of the replenishment in the request. -
replenishRequestLineDFFs: array
Flexfields
Title:
Flexfields
The Flexfields resource manages the descriptive flexfields for the replenish request. -
Subinventory: string
Title:
Subinventory
Maximum Length:10
Subinventory to use when sourcing the request. -
SubinventoryGroup: string
Title:
Subinventory Group
Maximum Length:100
Name of the subinventory group. -
UnitOfMeasure: string
Maximum Length:
25
Unit of measure for this item and request. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for this item and request.
array
Flexfields
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context name of the descriptive flexfield that the application uses to replenish request lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Display value of the descriptive flexfield that the application uses to replenish request lines. -
ReplenishmentIntId: integer
(int64)
Value that uniquely identifies the replenishment.
Response
- application/json
Default Response
-
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.
object
-
FailedRecordsCount: integer
Value that specifies the number of failed records.
-
GroupId: integer
(int64)
Read Only:
true
Value that uniquely identifies the replenish request group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
replenishRequestLines: array
Request Lines
Title:
Request Lines
The Request Lines resource manages the replenish request lines. -
ReturnMessageCode: string
Abbreviation that identifies the response message.
-
ReturnMessageText: string
Text of the response message.
-
ReturnStatus: string
Status of the current service call.
-
SubmitForProcessing: string
Contains Yes or No. Yes: process the balance records. No: do not process the records. The default value is No.
-
SuccessRecordsCount: integer
Value that specifies the number of successful records.
-
TotalRecordsCount: integer
Value that specifies the total number of records.
-
UserName: string
Maximum Length:
64
Name of the user who requested the inventory replenishment.
array
Links
array
Request Lines
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
ErrorMessageCode: string
Title:
Error
Read Only:true
Maximum Length:50
Abbreviation that identifies the error that occurred when processing the request. -
ErrorMessageText: string
Title:
Error
Read Only:true
Maximum Length:240
Text of the error message that occurred when processing the request. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemNumber: string
Title:
Item
Maximum Length:300
Number that uniquely identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LocatorName: string
Title:
Locator
Maximum Length:255
Name of the locator. -
NotPlannedRecords: number
Read Only:
true
Value that specifies the number of records that are not planned in a replenishment request. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization.
-
OverrideReplenishCountType: string
Type of override replenish count for the request.
-
OverrideReplenishCountTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of override replenish count for the request. -
ProcessingStatus: string
Title:
Processing Status
Read Only:true
Maximum Length:18
Default Value:PENDING
Processing status of this request. -
Quantity: number
Title:
Quantity
Quantity of the replenishment in the request. -
ReplenishmentIntId: integer
(int64)
Read Only:
true
Value that uniquely identifies replenishment record. -
replenishRequestLineDFFs: array
Flexfields
Title:
Flexfields
The Flexfields resource manages the descriptive flexfields for the replenish request. -
Subinventory: string
Title:
Subinventory
Maximum Length:10
Subinventory to use when sourcing the request. -
SubinventoryGroup: string
Title:
Subinventory Group
Maximum Length:100
Name of the subinventory group. -
UnitOfMeasure: string
Maximum Length:
25
Unit of measure for this item and request. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for this item and request.
array
Links
array
Flexfields
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context name of the descriptive flexfield that the application uses to replenish request lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Display value of the descriptive flexfield that the application uses to replenish request lines. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReplenishmentIntId: integer
(int64)
Value that uniquely identifies the replenishment.
array
Links
- replenishRequestLines
-
Operation: /fscmRestApi/resources/11.13.18.05/inventoryReplenishRequests/{GroupId}/child/replenishRequestLinesParameters:
- GroupId:
$request.path.GroupId
The Request Lines resource manages the replenish request lines. - GroupId:
Examples
This example describes how to create groups.
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/inventoryReplenishRequests"
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource to create a replenish request with online processing.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests"
Example 1 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.
{ "SubmitForProcessing" : "Yes", "replenishRequestLines": [ { "ItemNumber": "INV-100", "OrganizationCode": "M1", "Quantity": 100, "Subinventory": "PARREQ" } ] }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "GroupId": 1001, "UserName": null, "ReturnMessageCode": "INV_OUT_COMPL_MSG_ERR", "TotalRecordsCount": 1, "ReturnMessageText": " The process completed with errors.", "SubmitForProcessing": "Yes", "SuccessRecordsCount": 0, "ReturnStatus": "E", "FailedRecordsCount": 1, "replenishRequestLines": [ { "ErrorMessageCode": null, "ErrorMessageText": null, "InventoryItemId": null, "ItemNumber": "INV-100", "LocatorId": null, "LocatorName": null, "OrganizationCode": "M1", "OrganizationId": null, "UnitOfMeasure": null, "UOMCode": null, "Quantity": 100, "ReplenishmentIntId": 1001, "Subinventory": "PARREQ", "ProcessingStatus": "PENDING", "SubinventoryGroup": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1001/child/replenishRequestLines/1001", "name": "replenishRequestLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1001/child/replenishRequestLines/1001", "name": "replenishRequestLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1001", "name": "inventoryReplenishRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1001/child/replenishRequestLines/1001/child/replenishRequestLineDFFs", "name": "replenishRequestLineDFFs", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1001", "name": "inventoryReplenishRequests", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1001", "name": "inventoryReplenishRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1001/child/replenishRequestLines", "name": "replenishRequestLines", "kind": "collection" } ] }
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource to create a replenish request without online processing.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests"
Example 1 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.
{ "SubmitForProcessing" : "No", "replenishRequestLines": [ { "ItemNumber": "INV-100", "OrganizationCode": "M1", "Quantity": 100, "Subinventory": "PARREQ" } ] }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "GroupId": 1004, "UserName": null, "ReturnMessageCode": "INV_OUT_COMPL_MSG_SCC", "TotalRecordsCount": 1, "ReturnMessageText": "The process successfully completed.", "SubmitForProcessing": "No", "SuccessRecordsCount": null, "ReturnStatus": "SUCCESS", "FailedRecordsCount": null, "replenishRequestLines": [ { "ErrorMessageCode": null, "ErrorMessageText": null, "InventoryItemId": null, "ItemNumber": "INV-100", "LocatorId": null, "LocatorName": null, "OrganizationCode": "M1", "OrganizationId": null, "UnitOfMeasure": null, "UOMCode": null, "Quantity": 100, "ReplenishmentIntId": 1004, "Subinventory": "PARREQ", "ProcessingStatus": "PENDING", "SubinventoryGroup": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1004/child/replenishRequestLines/1004", "name": "replenishRequestLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1004/child/replenishRequestLines/1004", "name": "replenishRequestLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1004", "name": "inventoryReplenishRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1004/child/replenishRequestLines/1004/child/replenishRequestLineDFFs", "name": "replenishRequestLineDFFs", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1004", "name": "inventoryReplenishRequests", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1004", "name": "inventoryReplenishRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/1004/child/replenishRequestLines", "name": "replenishRequestLines", "kind": "collection" } ] }