1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Inventory Management
  4. Defaults Headers for Staged Item Transactions

Get one default header for the item-staged transaction

get

/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/{TransactionDefaultsHeaderId}

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 : itemStagedTransactionDefaults-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Defaults Lines for Staged Item Transactions
Type: array
Title: Defaults Lines for Staged Item Transactions
A line that???s ready to process staged item transactions.
Show Source
Nested Schema : itemStagedTransactionDefaults-Attachments-item-response
Type: object
Show Source
Nested Schema : itemStagedTransactionDefaults-ItemStagedTransactionDefaultsLine-item-response
Type: object
Show Source
  • Value that identifies the batch in which the record has been loaded into the table.
  • Maximum Length: 30
    Value that identifies the transaction type.
  • Maximum Length: 80
    Value that identifies the meaning of the transaction type.
  • Maximum Length: 240
    Code that identifies the status of the staged transaction's default lines.
  • Maximum Length: 240
    Explanation for the status of the staged transaction's default lines.
  • Value that uniquely identifies the item in the inventory organization.
  • Maximum Length: 300
    Number that identifies the item.
  • Links
  • Value that uniquely identifies the updated locator.
  • 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.
  • Maximum Length: 10
    Name of the updated subinventory where default lines of an item-staged transaction are created in the inventory organization.
  • Value that uniquely identifies the locator prior to the update.
  • 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.
  • 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.
  • Maximum Length: 18
    Abbreviation that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
  • Value that uniquely identifies the inventory organization that's enabled for the default line of the item-staged transaction.
  • Maximum Length: 240
    Name that identifies the inventory organization that's enabled for the default line of the item-staged transaction.
  • Maximum Length: 18
    Value that identifies if the status of the default lines of the staged transaction is valid.
  • Maximum Length: 11
    Name of the subinventory and locator where default lines for item-staged transactions are created in the inventory organization.
  • 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.
  • 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.
Links
Attachments
Parameters:
  • TransactionDefaultsHeaderId: $request.path.TransactionDefaultsHeaderId
The attachments resource is used to view, create, and update attachments.
ItemStagedTransactionDefaultsLine
Parameters:
  • TransactionDefaultsHeaderId: $request.path.TransactionDefaultsHeaderId
A line that???s ready to process staged item transactions.
Back to Top

Examples

This example describes how to get one default header for the item-staged 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/itemStagedTransactionDefaults/TransactionDefaultsHeaderId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/itemStagedTransactionDefaults?q=ProcessId is not null &OrganizationId=300100555990190"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "TransactionDefaultsHeaderId": "9001",
            "ActionCode": "UPDATE",
            "TotalLines": "3",
            "SuccessfulLines": null,
            "FailedLines": null,
            "StatusCode": "ORA_ERROR",
            "LockFlagValue": null,
            "CreatedBy": "WHSE_MGR_M2",
            "ObjectVersionNumber": 2,
            "CreationDate": "2024-01-31T08:41:05.001+00:00",
            "ProcessId": "203012",
            "ProcessMode": null,
            "AttachmentEntityName": "InvTransactionDefaults",
            "StatusCodeMeaning": "Error",
            "OrganizationId": "209",
            "PersonName": "Brent, Sam",
            "@context": {
                "key": "9001",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                },
                "links": [
                    {
                        "rel": "self",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/9001",
                        "name": "itemStagedTransactionDefaults",
                        "kind": "item"
                    },
                    {
                        "rel": "canonical",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/9001",
                        "name": "itemStagedTransactionDefaults",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/9001/child/Attachments",
                        "name": "Attachments",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/9001/child/ItemStagedTransactionDefaultsLine",
                        "name": "ItemStagedTransactionDefaultsLine",
                        "kind": "collection"
                    }
                ]
            }
        },
        {
            "TransactionDefaultsHeaderId": "1",
            "ActionCode": "CREATE",
            "TotalLines": "3",
            "SuccessfulLines": null,
            "FailedLines": null,
            "StatusCode": "ORA_ERROR",
            "LockFlagValue": null,
            "CreatedBy": "WHSE_MGR_M2",
            "ObjectVersionNumber": 2,
            "CreationDate": "2024-01-23T04:49:27.001+00:00",
            "ProcessId": "100515",
            "ProcessMode": null,
            "AttachmentEntityName": "InvTransactionDefaults",
            "StatusCodeMeaning": "Error",
            "OrganizationId": "209",
            "PersonName": "Brent, Sam",
            "@context": {
                "key": "1",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                },
                "links": [
                    {
                        "rel": "self",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/1",
                        "name": "itemStagedTransactionDefaults",
                        "kind": "item"
                    },
                    {
                        "rel": "canonical",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/1",
                        "name": "itemStagedTransactionDefaults",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/1/child/Attachments",
                        "name": "Attachments",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults/1/child/ItemStagedTransactionDefaultsLine",
                        "name": "ItemStagedTransactionDefaultsLine",
                        "kind": "collection"
                    }
                ]
            }
        }
    ],
    "count": 23,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://fa-wyjg-pintlabfadev.fa.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/itemStagedTransactionDefaults",
            "name": "itemStagedTransactionDefaults",
            "kind": "collection"
        }
    ]
}
Back to Top