GET action not supported
get
/fscmRestApi/resources/11.13.18.05/customerAssetTransactions
Request
Query Parameters
-
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: Find customer asset transactions according to the transaction identification.
Finder Variables:- TransactionId; integer; Value that uniquely identifies the customer asset transaction.
- PrimaryKey: Find customer asset transactions according to the transaction identification.
-
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:- 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.
- ReferencedTransactionId; integer; Value that uniquely identifies the transaction to be canceled. A value is required if the transaction type is ORA_CANCEL_TRANSACTION.
- SrcSystemType; string; Type of source system that sends the transaction. Valid values are ORA_EXTERNAL or ORA_INTERNAL, which are defined in lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. The attribute is required.
- SrcTransactionDate; string; Date when the transaction occurred in the source system. Only a past date can be provided. The attribute is required.
- SrcTransactionId; number; Value that identifies the transaction from the source application that created or updated the asset.
- SrcTransactionType; string; Type of asset transaction to be processed. Valid values are ORA_REPLACE, ORA_UPGRADE, or ORA_CANCEL_TRANSACTION, which are defined in the lookup type ORA_CSE_TRANSACTION_TYPE. The attribute is required.
- SrcTransactionTypeId; string; Value that identifies the type of transaction from the source application that created or updated the asset.
- 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.
-
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 : customerAssetTransactions
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 : customerAssetTransactions-item-response
Type:
Show Source
object
-
BusinessProcessCode: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferencedTransactionId: integer
(int64)
Value that uniquely identifies the transaction to be canceled. A value is required if the transaction type is ORA_CANCEL_TRANSACTION.
-
SrcSystem: string
Name of the source system sending the transaction. It is the name of the external application when source system type is ORA_EXTERNAL, or the Fusion product identifier when the source system type is ORA_INTERNAL. The attribute is required.
-
SrcSystemType: string
Maximum Length:
30
Type of source system that sends the transaction. Valid values are ORA_EXTERNAL or ORA_INTERNAL, which are defined in lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. The attribute is required. -
SrcTransactionDate: string
(date-time)
Date when the transaction occurred in the source system. Only a past date can be provided. The attribute is required.
-
SrcTransactionId: number
Read Only:
true
Value that identifies the transaction from the source application that created or updated the asset. -
SrcTransactionType: string
Maximum Length:
240
Type of asset transaction to be processed. Valid values are ORA_REPLACE, ORA_UPGRADE, or ORA_CANCEL_TRANSACTION, which are defined in the lookup type ORA_CSE_TRANSACTION_TYPE. The attribute is required. -
SrcTransactionTypeId: string
Read Only:
true
Maximum Length:30
Value that identifies the type of transaction from the source application that created or updated the asset. -
TransactedCustomerAsset: array
Transacted Customer Assets
Title:
Transacted Customer Assets
The Transacted Customer Assets resource manages details that allow you to create a customer asset. -
TransactionId: integer
(int64)
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transacted Customer Assets
Type:
array
Title:
Transacted Customer Assets
The Transacted Customer Assets resource manages details that allow you to create a customer asset.
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.
Nested Schema : customerAssetTransactions-TransactedCustomerAsset-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
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.
-
AssetNumber: string
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.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SalesOrderLineId: integer
(int64)
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
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. -
SalesOrderNumber: string
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. -
SrcOrderFulfillmentDate: string
(date-time)
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
(int64)
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
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. -
TransactionId: integer
(int64)
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
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. -
TransactionStatusCode: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source