Get one group
get
/fscmRestApi/resources/11.13.18.05/inventoryReplenishRequests/{GroupId}
Request
Path Parameters
-
GroupId(required): integer(int64)
Value that uniquely identifies the replenish request group.
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(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 : inventoryReplenishRequests-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Request Lines
Type:
array
Title:
Request Lines
The Request Lines resource manages the replenish request lines.
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 : inventoryReplenishRequests-replenishRequestLines-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The Flexfields resource manages the descriptive flexfields for the replenish request.
Show Source
Nested Schema : inventoryReplenishRequests-replenishRequestLines-replenishRequestLineDFFs-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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 get one group.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/GroupId"
For example, the following command gets one group where the group identifier is 2:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests/2"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "GroupId": 2, "UserName": null, "ReturnMessageCode": null, "TotalRecordsCount": null, "ReturnMessageText": null, "SubmitForProcessing": null, "SuccessRecordsCount": null, "ReturnStatus": null, "FailedRecordsCount": null, "replenishRequestLines": [ { "ErrorMessageCode": "FND_CMN_REQ_ATTRIB_API_SERV", "ErrorMessageText": "You must provide a value for the attribute Item.", "InventoryItemId": null, "ItemNumber": null, "LocatorId": null, "LocatorName": null, "OrganizationCode": "M1", "OrganizationId": 207, "UnitOfMeasure": null, "UOMCode": null, "Quantity": null, "ReplenishmentIntId": 2, "Subinventory": "TestCount", "ProcessingStatus": "ERROR", "SubinventoryGroup": null } ] } ], "count": 1, "hasMore": false, "limit": 2, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inventoryReplenishRequests", "name": "inventoryReplenishRequests", "kind": "collection" } ] }