Query for an existing inventory reservation interface record
get
/fscmRestApi/resources/11.13.18.05/inventoryStagedReservations/{inventoryStagedReservationsUniqID}
Request
Path Parameters
-
inventoryStagedReservationsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ReservationInterfaceId and ReservationBatchId ---for the Inventory Staged Reservations resource and used to uniquely identify an instance of Inventory Staged Reservations. The client should not generate the hash key value. Instead, the client should query on the Inventory Staged Reservations collection resource with a filter on the primary key values in order to navigate to a specific instance of Inventory Staged Reservations.
For example: inventoryStagedReservations?q=ReservationInterfaceId=<value1>;ReservationBatchId=<value2>
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 : inventoryStagedReservations-item-response
Type:
Show Source
object
-
DemandSourceHeaderId: integer
(int64)
Title:
Demand Document Number
Value that identifies the header number for source of demand. -
DemandSourceHeaderNumber: string
Maximum Length:
150
Identifies the header number for source of demand. -
DemandSourceLineId: integer
(int64)
Title:
Demand Document Line
Value that identifies the line number for demand source. -
DemandSourceLineNumber: string
Maximum Length:
150
Identifies the line number for demand source. -
DemandSourceName: string
Title:
Demand Document Name
Maximum Length:30
Identifies the user defined demand. -
DemandSourceTypeId: integer
(int64)
Title:
Demand Document Type ID
Value that identifies the type of demand. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined. -
DemandSourceTypeName: string
Maximum Length:
80
Identifies the type of demand. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined. -
ErrorCode: number
Title:
Error
Error code returned by the reservations interface manager. -
ErrorExplanation: string
Title:
Error Explanation
Maximum Length:240
Indicates the error message code for the record in the error. -
ErrorExplanationCode: string
Maximum Length:
240
Provides the error explanation code for the record in the error. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemNumber: string
Maximum Length:
300
Identifies the inventory item number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
255
Abbreviation that identifies the subinventory that the warehouse uses to reserve inventory for the item. It is typically a physical area in the subinventory, such as a row, aisle, bin, or shelf, that stores the item. -
LocatorId: integer
(int64)
Title:
Locator
Value that uniquely identifies the locator for the reservation. -
LockCode: string
Title:
Locked
Maximum Length:30
Default Value:2
Value that identifies if the record is locked to prevent the record from being picked by another reservation interface process. Valid values are 1 and 2. 1 indicates that the record is locked and 2 indicates that the record is available for a lock to be placed on it. The default value is 2. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies an item or group of items. Applies when the warehouse places the item under lot control. -
OrganizationCode: string
Maximum Length:
18
Organization for which the reservation is created. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization for which the reservation is created.
-
OrganizationName: string
Maximum Length:
240
Identifies organization name in which reservation function is performed -
PrimaryReservationQuantity: number
Title:
Reserved Quantity
Reserved quantity expressed in the primary unit of measure of the item. -
PrimaryUnitOfMeasure: string
Maximum Length:
25
Primary unit of measure of the item. -
PrimaryUOMCode: string
Maximum Length:
3
Abbreviation that identifies the primary unit of measure. -
ProcessMode: string
Maximum Length:
255
Mode in which interface record has to be processed. It has values : Online,Concurrent,Background. Value that identifies the mode of the processing the inventory attribute transaction request lines. It has values : Online,Concurrent,Background. Valid values include 1, 2, and 3. 1 indicates online, 2 indicates concurrent, and 3 indicates background. 1 indicates that the records are inserted in the Inventory Reservations interface with the transaction mode as 1. This invokes Manage Reservations Interface scheduled process to process the records in the reservation interface. 2 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 2. This invokes Manage Reservations Interface to process the records in the reservation interface. 3 indicates that the records are inserted in the Inventory Reservations interface with transaction mode as 3. User needs to invoke the Manage Reservations Interface scheduled process manually to process the records in the reservation interface. -
ProcessModeCode: string
Value that identifies the process mode to be used to process the interface records. Valid values are 1, 2, and 3. 1 indicates online mode of processing, 2 indicates concurrent mode, and 3 indicates background mode.
-
RequirementDate: string
(date)
Title:
Due Date
Indicates the requirement date for the reservation. -
ReservationActionCode: string
Title:
Reservation Action
Maximum Length:30
Value that identifies the reservation action that needs to be performed. Valis values are 1, 2, 3, and 4. 1 indicates Create, 2 indicates Update, 3 indicates Delete, and 4 indicates Transfer. -
ReservationBatchId: integer
(int64)
Title:
Reservation Batch ID
Value that identifies a reservation batch. -
ReservationInterfaceId: integer
(int64)
Value that identifies a unique reservation record.
-
ReservationQuantity: number
Title:
Reserved Quantity
Identifies the quantity to be reserved in reservation UOM code. -
ReservationUnitOfMeasure: string
Maximum Length:
25
Identifies the unit of measure for the reservation record. -
ReservationUOMCode: string
Title:
Reservation UOM
Maximum Length:3
Abbreviation that identifies the unit of measure that the user chooses when placing the reservation. -
Revision: string
Maximum Length:
18
Revision of the item. Applies when the warehouse enables the item for revision control. -
RowStatusCode: string
Title:
Row Status
Maximum Length:30
Indicates the status of the request. Valid values are 1 and 3. 1 indicates Active, and 3 indicates Error. -
SecondaryReservationQuantity: number
Title:
Secondary Reserved Quantity
Reservation quantity expressed in the secondary unit of measure. -
SecondaryUnitOfMeasure: string
Maximum Length:
25
Secondary unit of measure of the item. -
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Abbreviation that identifies the secondary unit of measure. -
SourceFulfillmentLineId: integer
(int64)
Value that identifies the source fulfillment line for sales order demand.
-
SubinventoryCode: string
Maximum Length:
10
Name of the subinventory that the warehouse uses to make the reservation. -
SupplyProjectId: integer
(int64)
Value that uniquely identifies the project for the supply document.
-
SupplyProjectNumber: string
Maximum Length:
25
Number that identifies the project for the supply document. -
SupplySourceHeaderId: integer
(int64)
Title:
Supply Document Number
Value that identifies the supply document. -
SupplySourceHeaderNumber: string
Maximum Length:
150
Identifies the supply document. -
SupplySourceLineId: integer
(int64)
Title:
Supply Document Line
Value that identifies the line number in the supply document. -
SupplySourceLineNumber: string
Maximum Length:
150
Line number in the supply document. -
SupplySourceTypeId: integer
(int64)
Title:
Supply Document Type
Value that uniquely identifies the type of the supply document. -
SupplySourceTypeName: string
Maximum Length:
80
Type of the supply document. A list of accepted values is defined in the lookup type INV_RESERVATION_SUPPLY_SRC_TYP. Values include Purchase Order, On Hand, Requisition, Transfer Order Return, Work Order, or Transfer Order. -
SupplyTaskId: integer
(int64)
Value that uniquely identifies the task corresponding to a project for the supply document.
-
SupplyTaskNumber: string
Maximum Length:
100
Number that identifies the task corresponding to a project for the supply document. -
ToDemandSourceHeaderId: integer
(int64)
Title:
To Demand Document Number
Value that identifies the header number for destination source of demand to update or transfer the reservation. -
ToDemandSourceHeaderNumber: string
Maximum Length:
150
Identifies the header number for destination source of demand to update or transfer the reservation. -
ToDemandSourceLineId: integer
(int64)
Title:
To Demand Document Line ID
Value that identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation. -
ToDemandSourceLineNumber: string
Maximum Length:
150
Identifies the line number corresponding to a header number for destination source of demand to update or transfer the reservation. -
ToDemandSourceName: string
Title:
To Demand Document Name
Maximum Length:30
Identifies the header number for source of demand to update or transfer the reservation. -
ToDemandSourceTypeId: integer
(int64)
Title:
To Demand Document Type
Identifies the destination demand source type name to update or transfer the reservation. Valid values are 2, 3, 6, 8,and 13. 2 indicates Sales Order, 3 indicates Account, 6 indicates Account Alias, 8 indicates Transfer Order and 13 indicates User defined. -
ToDemandSourceTypeName: string
Maximum Length:
80
Identifies the destination demand source type name to update or transfer the reservation. Valid values are Sales Order, Account, Account Alias, Transfer Order, and User defined. -
ToLocator: string
Maximum Length:
255
Identifies the destination locator to update or transfer the reservation. -
ToLocatorId: integer
(int64)
Title:
To Locator
Value that identifies the destination locator to update or transfer the reservation. -
ToLotNumber: string
Title:
To Lot
Maximum Length:80
Identifies the lot number to update or transfer the reservation. -
ToOrganizationId: integer
(int64)
Title:
To Organization
Value that identifies the organization name to which the reservation is updated or transferred. -
ToOrganizationName: string
Maximum Length:
240
Identifies the organization name to which the reservation is updated or transferred. -
ToRevision: string
Title:
To Revision
Maximum Length:18
Identifies the destination revision for a revision controlled reserved item. -
ToSubinventoryCode: string
Title:
To Subinventory
Maximum Length:10
Identifies the destination subinventory to update or transfer the reservation. -
ToSupplyProjectId: integer
(int64)
Number that identifis the destination supply project to update or transfer the reservation.
-
ToSupplyProjectNumber: string
Maximum Length:
25
Name of the destination supply project to update or transfer the reservation. -
ToSupplySourceHeaderId: integer
(int64)
Title:
To Supply Document Number
Value that identifies the header number for a destination supply source to update or transfer the reservation. -
ToSupplySourceHeaderNumber: string
Maximum Length:
150
Identifies the header number for a destination supply source to update or transfer the reservation. -
ToSupplySourceLineId: integer
(int64)
Title:
To Supply Document Line
Value that identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation. -
ToSupplySourceLineNumber: string
Maximum Length:
150
Identifies the line number corresponding to a header number for a destination supply source to update or transfer the reservation. -
ToSupplySourceTypeId: integer
(int64)
Title:
To Supply Document Type
Value that identifies the destination supply source nameto update or transfer the reservation. -
ToSupplySourceTypeName: string
Maximum Length:
80
Identifies the destination supply source name to update or transfer the reservation. -
ToSupplyTaskId: integer
(int64)
Value that identifies the destination task used to update and transfer the reservation.
-
ToSupplyTaskNumber: string
Maximum Length:
100
Identifies the destination task used to update and transfer the reservation.
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 query for an existing inventory reservation interface record .
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/inventoryStagedReservations/inventoryStagedReservationsUniqID"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/inventoryStagedReservations?q=ReservationBatchId=12341"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [], "count": 0, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/inventoryStagedReservations", "name": "inventoryStagedReservations", "kind": "collection" } ] }