Get one transaction

get

/fscmRestApi/resources/11.13.18.05/inventoryStagedTransactions/{TransactionInterfaceId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : inventoryStagedTransactions-item-response
Type: object
Show Source
Nested Schema : Costs
Type: array
Title: Costs
The Costs resource manages the costs associated with the inventory staged transaction.
Show Source
Nested Schema : Flexfields for Inventory Staged Transactions
Type: array
Title: Flexfields for Inventory Staged Transactions
The Flexfields for Inventory Staged Transactions resource manages the descriptive flexfields defined for the transaction.
Show Source
Nested Schema : Lots
Type: array
Title: Lots
The Lots resource manages the lots of a staged inventory transaction.
Show Source
Nested Schema : Project Cost Details
Type: array
Title: Project Cost Details
The Project Cost Details resource manages the project cost elements associated with the inventory staged transaction.
Show Source
Nested Schema : Serials
Type: array
Title: Serials
The Serials resource manages the serials of a staged inventory transaction for a serial controlled item.
Show Source
Nested Schema : Tracking Attributes
Type: array
Title: Tracking Attributes
The Tracking Attributes resource manages the inventory tracking attribute associated with the inventory staged transaction. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : inventoryStagedTransactions-costs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-dFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-item-response
Type: object
Show Source
Nested Schema : Flexfields for Lot Attributes
Type: array
Title: Flexfields for Lot Attributes
The Flexfields for Lot Attributes resource manages the lot attributes descriptive flexfields for a lot controlled item.
Show Source
Nested Schema : Lot Serials
Type: array
Title: Lot Serials
The Lot Serials resource manages the serials for a lot of a staged inventory transaction when an item is both lot and serial controlled.
Show Source
Nested Schema : Flexfields for Lots
Type: array
Title: Flexfields for Lots
The Flexfields for Lots resource manages the lot descriptive flexfields for a lot controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-serialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotSerials-serialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-lots-lotStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-projectCostingDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-serials-item-response
Type: object
Show Source
Nested Schema : Flexfields for Serial Attributes
Type: array
Title: Flexfields for Serial Attributes
The Flexfields for Serial Attributes resource manages the serial attributes descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : Flexfields for Serials
Type: array
Title: Flexfields for Serials
The Flexfields for Serials resource manages the serial descriptive flexfields for a serial controlled item.
Show Source
Nested Schema : inventoryStagedTransactions-serials-serialAttributeDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-serials-serialStandardDFFs-item-response
Type: object
Show Source
Nested Schema : inventoryStagedTransactions-trackingAttributesDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name for tracking attributes. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value for tracking attributes. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the transaction. This attribute is associated with a feature that requires opt in.
Back to Top

Examples

This example describes how to get one transaction.

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/inventoryStagedTransactions/TransactionInterfaceId"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "OrganizationId": null,
    "OrganizationName": "Seven Corporation",
    "InventoryItemId": null,
    "ItemNumber": "VC105",
    "ItemDescription": null,
    "Revision": null,
    "SubinventoryCode": "Staging1",
....
}
Back to Top