PATCH action not supported
patch
/fscmRestApi/resources/11.13.18.05/customerAssetTransactions/{TransactionId}
Request
Path Parameters
-
TransactionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
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: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
BusinessProcessCode: string
Maximum Length:
30Abbreviation identifying the process used when staged transactions are created for replacement or advance exchange processing. Differentiates exchange and depot repair processes. -
ReferencedTransactionId: integer
(int64)
Value that uniquely identifies the transaction to be canceled. Required if the transaction type is ORA_CANCEL_TRANSACTION.
-
SrcSystem: string
Name of the source system sending the transaction. It's the external application name for ORA_EXTERNAL, or the product identifier for ORA_INTERNAL. This attribute is required.
-
SrcSystemType: string
Maximum Length:
30Type of source system sending the transaction. Valid values are ORA_EXTERNAL or ORA_INTERNAL, defined in lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. This attribute is required. -
SrcTransactionDate: string
(date-time)
Date when the transaction occurred in the source system. Only past dates are allowed. This attribute is required.
-
SrcTransactionType: string
Maximum Length:
240Type of asset transaction to be processed. Valid values are ORA_REPLACE, ORA_UPGRADE, or ORA_CANCEL_TRANSACTION, defined in lookup type ORA_CSE_TRANSACTION_TYPE. This attribute is required. -
TransactedCustomerAsset: array
Transacted Customer Assets
Title:
Transacted Customer AssetsInformation required to create and configure a customer asset. -
TransactionId: integer
(int64)
Value that uniquely identifies the asset transaction. Generated by the application when the transaction is created. Read-only.
Nested Schema : Transacted Customer Assets
Type:
arrayTitle:
Transacted Customer AssetsInformation required to create and configure a customer asset.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AssetId: integer
(int64)
Value that uniquely identifies the asset. A customer asset identifying the replaced asset is required for ORA_INBOUND transaction lines. A customer asset identifying the replacement asset is required for ORA_OUTBOUND lines with ORA_EXTERNAL source system. Either the asset number or identifier can be provided.
-
AssetNumber: string
Number uniquely identifying the asset. Rules for ORA_INBOUND and ORA_OUTBOUND are the same as above.
-
SalesOrderLineId: integer
(int64)
Value that uniquely identifies the order line. For ORA_INBOUND, it's the return material authorization line, for ORA_OUTBOUND, it's the sales order line.
-
SalesOrderLineNumber: string
Maximum Length:
120Number identifying the order line. For ORA_INBOUND, it's the return material authorization line number. For ORA_OUTBOUND, it's the sales order line number. For ORA_INTERNAL source system, the value defaults to the sales order line number from the order line identifier. -
SalesOrderNumber: string
Maximum Length:
120Number identifying the order. For ORA_INBOUND, it's the return material authorization order number. For ORA_OUTBOUND, it's the sales order number. For ORA_INTERNAL source system, the value defaults to the sales order number from the order line identifier. -
SrcOrderFulfillmentDate: string
(date-time)
Date when the order line is fulfilled in the source system. For ORA_EXTERNAL, a past date is required. For ORA_INTERNAL, order fulfillment dates are used as the source of truth.
-
TransactedAssetId: integer
(int64)
Value that uniquely identifies the transacted asset in the asset transaction. Generated by the application. Read-only.
-
TransactedQuantity: number
Quantity of the transaction for the asset. For ORA_INBOUND, it's the quantity to be replaced. For ORA_OUTBOUND, it's the replacement quantity. Quantities and units of measure default from the assets (ORA_EXTERNAL) or from order lines (ORA_INTERNAL).
-
TransactedUOMCode: string
Maximum Length:
3Abbreviation identifying the UOM of the transacted asset quantity. Must be convertible to the primary asset item UOM for nonserialized products. Defaults to primary asset item UOM if not provided. -
TransactionId: integer
(int64)
Value that uniquely identifies the asset transaction.
-
TransactionLineType: string
Maximum Length:
30Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, defined in lookup type ORA_CSE_TXN_LINE_TYPE. For ORA_REPLACE or ORA_UPGRADE, one inbound line and one outbound line are required.
Response
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-item-response
Type:
Show Source
object-
BusinessProcessCode: string
Maximum Length:
30Abbreviation identifying the process used when staged transactions are created for replacement or advance exchange processing. Differentiates exchange and depot repair processes. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReferencedTransactionId: integer
(int64)
Value that uniquely identifies the transaction to be canceled. Required if the transaction type is ORA_CANCEL_TRANSACTION.
-
SrcSystem: string
Name of the source system sending the transaction. It's the external application name for ORA_EXTERNAL, or the product identifier for ORA_INTERNAL. This attribute is required.
-
SrcSystemType: string
Maximum Length:
30Type of source system sending the transaction. Valid values are ORA_EXTERNAL or ORA_INTERNAL, defined in lookup type ORA_CSE_SOURCE_SYSTEM_TYPE. This attribute is required. -
SrcTransactionDate: string
(date-time)
Date when the transaction occurred in the source system. Only past dates are allowed. This attribute is required.
-
SrcTransactionId: number
Read Only:
trueValue identifying the transaction from the source application that created or updated the asset. -
SrcTransactionType: string
Maximum Length:
240Type of asset transaction to be processed. Valid values are ORA_REPLACE, ORA_UPGRADE, or ORA_CANCEL_TRANSACTION, defined in lookup type ORA_CSE_TRANSACTION_TYPE. This attribute is required. -
SrcTransactionTypeId: string
Read Only:
trueMaximum Length:30Value identifying the type of transaction from the source application that created or updated the asset. -
TransactedCustomerAsset: array
Transacted Customer Assets
Title:
Transacted Customer AssetsInformation required to create and configure a customer asset. -
TransactionId: integer
(int64)
Value that uniquely identifies the asset transaction. Generated by the application when the transaction is created. Read-only.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Transacted Customer Assets
Type:
arrayTitle:
Transacted Customer AssetsInformation required to create and configure a customer asset.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 for ORA_INBOUND transaction lines. A customer asset identifying the replacement asset is required for ORA_OUTBOUND lines with ORA_EXTERNAL source system. Either the asset number or identifier can be provided.
-
AssetNumber: string
Number uniquely identifying the asset. Rules for ORA_INBOUND and ORA_OUTBOUND are the same as above.
-
BusinessProcessCode: string
Read Only:
trueMaximum Length:30Abbreviation identifying the process used when staged transactions are created for replacement or advance exchange processing. Differentiates exchange and depot repair processes. (duplicate of 12 consider removing) -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SalesOrderLineId: integer
(int64)
Value that uniquely identifies the order line. For ORA_INBOUND, it's the return material authorization line, for ORA_OUTBOUND, it's the sales order line.
-
SalesOrderLineNumber: string
Maximum Length:
120Number identifying the order line. For ORA_INBOUND, it's the return material authorization line number. For ORA_OUTBOUND, it's the sales order line number. For ORA_INTERNAL source system, the value defaults to the sales order line number from the order line identifier. -
SalesOrderNumber: string
Maximum Length:
120Number identifying the order. For ORA_INBOUND, it's the return material authorization order number. For ORA_OUTBOUND, it's the sales order number. For ORA_INTERNAL source system, the value defaults to the sales order number from the order line identifier. -
SrcOrderFulfillmentDate: string
(date-time)
Date when the order line is fulfilled in the source system. For ORA_EXTERNAL, a past date is required. For ORA_INTERNAL, order fulfillment dates are used as the source of truth.
-
TransactedAssetId: integer
(int64)
Value that uniquely identifies the transacted asset in the asset transaction. Generated by the application. Read-only.
-
TransactedQuantity: number
Quantity of the transaction for the asset. For ORA_INBOUND, it's the quantity to be replaced. For ORA_OUTBOUND, it's the replacement quantity. Quantities and units of measure default from the assets (ORA_EXTERNAL) or from order lines (ORA_INTERNAL).
-
TransactedUOMCode: string
Maximum Length:
3Abbreviation identifying the UOM of the transacted asset quantity. Must be convertible to the primary asset item UOM for nonserialized products. Defaults to primary asset item UOM if not provided. -
TransactionId: integer
(int64)
Value that uniquely identifies the asset transaction.
-
TransactionLineType: string
Maximum Length:
30Type of transaction line. Valid values are ORA_INBOUND or ORA_OUTBOUND, defined in lookup type ORA_CSE_TXN_LINE_TYPE. For ORA_REPLACE or ORA_UPGRADE, one inbound line and one outbound line are required. -
TransactionStatusCode: string
Read Only:
trueMaximum Length:30Abbreviation identifying the status of the transacted asset. Values are ORA_PENDING or ORA_COMPLETED. For ORA_INTERNAL, status starts as ORA_PENDING and moves to ORA_COMPLETED when the order is fulfilled. For ORA_EXTERNAL, status is directly set to ORA_COMPLETED.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- TransactedCustomerAsset
-
Parameters:
- TransactionId:
$request.path.TransactionId
Information required to create and configure a customer asset. - TransactionId: