1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Customer Asset Transactions
  5. Transacted Customer Assets

Get all assets

get

/fscmRestApi/resources/11.13.18.05/customerAssetTransactions/{TransactionId}/child/TransactedCustomerAsset

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
  • 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: Find transacted customer assets according to the transacted customer asset identification.
      Finder Variables:
      • TransactedAssetId; integer; Value that uniquely identifies the transacted customer asset.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AssetId; integer; Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.
    • BusinessProcessCode; string; Abbreviation that identifies the process to be used when the staged transactions are created for the replacement or advance exchange processing. This attribute differentiates the exchange process and the depot repair process.
    • SalesOrderLineId; integer; Value that uniquely identifies the order line. It is the return material authorization line for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line for the replacement asset if the transaction line type is ORA_OUTBOUND.
    • SalesOrderLineNumber; string; Number that identifies the order line. It is the return material authorization line number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order line number from the order line identifier for the transaction.
    • SalesOrderNumber; string; Number that identifies the order. It is the return material authorization order number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order number from the order line identifier for the transaction.
    • SrcOrderFulfillmentDate; string; Date when the order line is fulfilled in the source system. If the source system type is ORA_EXTERNAL, a value is required, only a past date can be provided. When the source system type is ORA_INTERNAL, the fulfillment dates of the orders are used as the source of truth.
    • TransactedAssetId; integer; Value that uniquely identifies transacted asset in the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
    • TransactedQuantity; number; Quantity of transaction for the asset. It is the quantity to be replaced when the transaction line type is ORA_INBOUND. It is the replacement quantity when the transaction line type is ORA_OUTBOUND. If the source system type is ORA_EXTERNAL, quantities and unit of measures for the transaction are defaulted from the assets. If the source system is ORA_INTERNAL, quantities and unit of measures for the transaction are defaulted from the order lines.
    • TransactedUOMCode; string; Abbreviation that identifies the unit of measure of the transacted asset quantity. It must be convertible to the primary asset item unit of measure for non-serialized products. If it is not provided, it is defaulted to the primary asset item unit of measure.
    • TransactionId; integer; Value that uniquely identifies the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
    • TransactionLineType; string; Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, which are defined in the lookup type ORA_CSE_TXN_LINE_TYPE. It is required to provide one transaction line of ORA_INBOUND type and one line of ORA_OUTBOUND type when the transaction type is ORA_REPLACE or ORA_UPGRADE.
    • TransactionStatusCode; string; Abbreviation that identifies the status of the transacted asset. This attribute is read-only. Values are ORA_PENDING or ORA_COMPLETED. When the source system type is ORA_INTERNAL, the transaction status is initially set to ORA_PENDING. It moves to ORA_COMPLETED whenever the corresponding order is fulfilled. When the source system is ORA_EXTERNAL, the transaction status is directly set to ORA_COMPLETED since it is assumed that the orders are fulfilled in the source system.
  • 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
  • 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 : customerAssetTransactions-TransactedCustomerAsset
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : customerAssetTransactions-TransactedCustomerAsset-item-response
Type: object
Show Source
  • Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.
  • Number that uniquely identifies the asset. A customer asset identifying the replaced asset is required if the transaction line type is ORA_INBOUND. A customer asset identifying the replacement asset is required if the transaction line type is ORA_OUTBOUND and the source system type is ORA_EXTERNAL. You can provide either the asset number or the asset identifier.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the process to be used when the staged transactions are created for the replacement or advance exchange processing. This attribute differentiates the exchange process and the depot repair process.
  • Links
  • Value that uniquely identifies the order line. It is the return material authorization line for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line for the replacement asset if the transaction line type is ORA_OUTBOUND.
  • Maximum Length: 120
    Number that identifies the order line. It is the return material authorization line number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order line number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order line number from the order line identifier for the transaction.
  • Maximum Length: 120
    Number that identifies the order. It is the return material authorization order number for the replaced asset if the transaction line type is ORA_INBOUND. It is the sales order number for the replacement asset if the transaction line type is ORA_OUTBOUND. If the source system type is ORA_INTERNAL, the value provided is ignored and the value defaults to the sales order number from the order line identifier for the transaction.
  • Date when the order line is fulfilled in the source system. If the source system type is ORA_EXTERNAL, a value is required, only a past date can be provided. When the source system type is ORA_INTERNAL, the fulfillment dates of the orders are used as the source of truth.
  • Value that uniquely identifies transacted asset in the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
  • Quantity of transaction for the asset. It is the quantity to be replaced when the transaction line type is ORA_INBOUND. It is the replacement quantity when the transaction line type is ORA_OUTBOUND. If the source system type is ORA_EXTERNAL, quantities and unit of measures for the transaction are defaulted from the assets. If the source system is ORA_INTERNAL, quantities and unit of measures for the transaction are defaulted from the order lines.
  • Maximum Length: 3
    Abbreviation that identifies the unit of measure of the transacted asset quantity. It must be convertible to the primary asset item unit of measure for non-serialized products. If it is not provided, it is defaulted to the primary asset item unit of measure.
  • Value that uniquely identifies the asset transaction. It is a value that the application generates when it creates a transaction. This attribute is read-only.
  • Maximum Length: 30
    Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, which are defined in the lookup type ORA_CSE_TXN_LINE_TYPE. It is required to provide one transaction line of ORA_INBOUND type and one line of ORA_OUTBOUND type when the transaction type is ORA_REPLACE or ORA_UPGRADE.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the status of the transacted asset. This attribute is read-only. Values are ORA_PENDING or ORA_COMPLETED. When the source system type is ORA_INTERNAL, the transaction status is initially set to ORA_PENDING. It moves to ORA_COMPLETED whenever the corresponding order is fulfilled. When the source system is ORA_EXTERNAL, the transaction status is directly set to ORA_COMPLETED since it is assumed that the orders are fulfilled in the source system.
Back to Top

Examples

This example describes how to get all assets in one customer 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/customerAssetTransactions/TransactionId/child/TransactedCustomerAsset"

For example, the following command gets all assets in customer transaction 100100053526089:

curl -u username:password "https://servername/fscmRestApi/resources/version/customerAssetTransactions/100100053526089/child/TransactedCustomerAsset"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "TransactionId" : 100100053526089,
    "TransactedAssetId" : 100100053526292,
    "TransactionLineType" : null,
    "AssetId" : 100100053526091,
    "AssetNumber" : "100100053526091",
    "SalesOrderLineId" : null,
    "SalesOrderLineNumber" : null,
    "SalesOrderNumber" : null,
    "TransactedQuantity" : 1,
    "TransactedUOMCode" : "Ea",
    "TransactionStatusCode" : null,
    "SrcOrderFulfillmentDate" : null}]
}
Back to Top