Get all default lines for an item-staged transaction
get
/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/{TransactionDefaultsHeaderId}/child/ItemStagedTransactionDefaultsLine
Request
Path Parameters
-
TransactionDefaultsHeaderId(required): integer(int64)
Value that uniquely identifies the default header of the item-staged transaction. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the default line of the item-staged transaction using the primary key.
Finder Variables:- TransactionDefaultsLineId; integer; Value that uniquely identifies the default line of the item-staged transaction . It's a primary key that the application generates when it creates the default line of the item-staged transaction. This attribute is required.
- PrimaryKey: Finds the default line of the item-staged transaction using the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BatchId; integer; Value that identifies the batch in which the record has been loaded into the table.
- DefaultType; string; Value that identifies the transaction type.
- DefaultTypeMeaning; string; Value that identifies the meaning of the transaction type.
- ErrorCode; string; Code that identifies the status of the staged transaction's default lines.
- ErrorExplanation; string; Explanation for the status of the staged transaction's default lines.
- InventoryItemId; integer; Value that uniquely identifies the item in the inventory organization.
- ItemNumber; string; Number that identifies the item.
- NewLocatorId; integer; Value that uniquely identifies the updated locator.
- NewLocatorName; string; Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization.
- NewSubinventoryCode; string; Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization.
- OldLocatorId; integer; Value that uniquely identifies the locator prior to the update.
- OldLocatorName; string; Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization.
- OldSubinventoryCode; string; Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization.
- OrganizationCode; string; Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
- OrganizationId; integer; Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
- OrganizationName; string; Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
- StatusCode; string; Value that identifies if the status of the default lines of the staged transaction is valid.
- SubDefault; string; Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization.
- TransactionDefaultsHeaderId; integer; Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
- TransactionDefaultsLineId; integer; Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : itemStagedTransactionDefaults-ItemStagedTransactionDefaultsLine
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : itemStagedTransactionDefaults-ItemStagedTransactionDefaultsLine-item-response
Type:
Show Source
object
-
BatchId: integer
(int64)
Value that identifies the batch in which the record has been loaded into the table.
-
DefaultType: string
Maximum Length:
30
Value that identifies the transaction type. -
DefaultTypeMeaning: string
Maximum Length:
80
Value that identifies the meaning of the transaction type. -
ErrorCode: string
Maximum Length:
240
Code that identifies the status of the staged transaction's default lines. -
ErrorExplanation: string
Maximum Length:
240
Explanation for the status of the staged transaction's default lines. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item in the inventory organization.
-
ItemNumber: string
Maximum Length:
300
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewLocatorId: integer
(int64)
Value that uniquely identifies the updated locator.
-
NewLocatorName: string
Maximum Length:
240
Name of the updated locator in a subinventory where default lines of an item-staged transaction are created in the inventory organization. -
NewSubinventoryCode: string
Maximum Length:
10
Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization. -
OldLocatorId: integer
(int64)
Value that uniquely identifies the locator prior to the update.
-
OldLocatorName: string
Maximum Length:
240
Name of the locator in a subinventory prior to an update where default lines for an item-staged transaction are created in the inventory organization. -
OldSubinventoryCode: string
Maximum Length:
10
Name of the subinventory prior to the update in which default lines for item-staged transactions are created in the inventory organization. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
-
OrganizationName: string
Maximum Length:
240
Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction. -
StatusCode: string
Maximum Length:
18
Value that identifies if the status of the default lines of the staged transaction is valid. -
SubDefault: string
Maximum Length:
11
Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization. -
TransactionDefaultsHeaderId: integer
(int64)
Value that uniquely identifies the item-staged transaction header. It's a primary key that the application generates when it creates the default header of the item-staged transaction.
-
TransactionDefaultsLineId: integer
(int64)
Value that uniquely identifies the default line of the item-staged transaction. It's a primary key that the application generates when it creates the item-staged transaction default line.
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.