REST API for Oracle Fusion Cloud SCM

GET action not supported

get

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

Request

Path Parameters

TransactionId(required): 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.

Query Parameters

dependency: string

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>
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
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
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "SrcTransactionType":{
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "SrcTransactionTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the type of transaction from the source application that created or updated the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrcSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcTransactionDate":{
            "type":"string",
            "description":"Date when the transaction occurred in the source system. Only a past date can be provided. The attribute is required.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "SrcSystemType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcTransactionId":{
            "type":"number",
            "description":" Value that identifies the transaction from the source application that created or updated the asset.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactedCustomerAsset":{
            "title":"Transacted Customer Assets",
            "type":"array",
            "description":"The Transacted Customer Assets resource manages details that allow you to create a customer asset.",
            "items":{
                "$ref":"#/components/schemas/customerAssetTransactions-TransactedCustomerAsset-item-response"
            }
        },
        "BusinessProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReferencedTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction to be canceled. A value is required if the transaction type is ORA_CANCEL_TRANSACTION.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

Array of: object customerAssetTransactions-TransactedCustomerAsset-item-response

{
    "title":"Transacted Customer Assets",
    "type":"array",
    "description":"The Transacted Customer Assets resource manages details that allow you to create a customer asset.",
    "items":{
        "$ref":"#/components/schemas/customerAssetTransactions-TransactedCustomerAsset-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : customerAssetTransactions-TransactedCustomerAsset-item-response

Type: object

Show Source

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.
BusinessProcessCode: string

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: 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.

{
    "type":"object",
    "properties":{
        "TransactionLineType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetNumber":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcOrderFulfillmentDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactedUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactedAssetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TransactionStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactedQuantity":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

TransactedCustomerAsset

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

Parameters:

TransactionId: $request.path.TransactionId

The Transacted Customer Assets resource manages details that allow you to create a customer asset.