REST API for Oracle Fusion Cloud SCM

Get all

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 Finds the customer asset transactions using the transaction identifier.
  Finder Variables
  - TransactionId; integer; Value that uniquely identifies the customer asset transaction.
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 identifying the process used when staged transactions are created for replacement or advance exchange processing. Differentiates exchange and depot repair processes.
- ReferencedTransactionId; integer; Value that uniquely identifies the transaction to be canceled. Required if the transaction type is ORA_CANCEL_TRANSACTION.
- SrcSystemType; string; Type 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 when the transaction occurred in the source system. Only past dates are allowed. This attribute is required.
- SrcTransactionId; number; Value identifying 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, defined in lookup type ORA_CSE_TRANSACTION_TYPE. This attribute is required.
- SrcTransactionTypeId; string; Value identifying the type of transaction from the source application that created or updated the asset.
- TransactionId; integer; Value that uniquely identifies the asset transaction. Generated by the application when the transaction is created. 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: 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.

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

Type: object

Show Source

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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/customerAssetTransactions-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object customerAssetTransactions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/customerAssetTransactions-item-response"
    }
}

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 : customerAssetTransactions-item-response

Type: object

Show Source

BusinessProcessCode: string

Maximum Length: 30

Abbreviation 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: Links

The 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: 30

Type 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: true

Value identifying 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, defined in lookup type ORA_CSE_TRANSACTION_TYPE. This attribute is required.
SrcTransactionTypeId: string

Read Only: true

Maximum Length: 30

Value identifying the type of transaction from the source application that created or updated the asset.
TransactedCustomerAsset: array Transacted Customer Assets

Title: Transacted Customer Assets

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

{
    "type":"object",
    "properties":{
        "BusinessProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation identifying the process used when staged transactions are created for replacement or advance exchange processing. Differentiates exchange and depot repair processes.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferencedTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction to be canceled. Required if the transaction type is ORA_CANCEL_TRANSACTION.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrcSystem":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SrcSystemType":{
            "maxLength":30,
            "type":"string",
            "description":"Type 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.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcTransactionDate":{
            "type":"string",
            "description":"Date when the transaction occurred in the source system. Only past dates are allowed. This attribute is required.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "SrcTransactionId":{
            "type":"number",
            "description":"Value identifying 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
        },
        "SrcTransactionType":{
            "maxLength":240,
            "type":"string",
            "description":"Type 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.",
            "nullable":false,
            "x-queryable":true
        },
        "SrcTransactionTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"Value identifying the type of transaction from the source application that created or updated the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactedCustomerAsset":{
            "title":"Transacted Customer Assets",
            "type":"array",
            "description":"Information required to create and configure a customer asset.",
            "items":{
                "$ref":"#/components/schemas/customerAssetTransactions-TransactedCustomerAsset-item-response"
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset transaction. Generated by the application when the transaction is created. Read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "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"
            }
        }
    }
}

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

Information required to create and configure a customer asset.

Show Source

Array of: object customerAssetTransactions-TransactedCustomerAsset-item-response

{
    "title":"Transacted Customer Assets",
    "type":"array",
    "description":"Information required to create and configure 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 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: true

Maximum Length: 30

Abbreviation 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: Links

The 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: 120

Number 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: 120

Number 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: 3

Abbreviation 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: 30

Type 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: true

Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "type":"string",
            "description":"Number uniquely identifying the asset. Rules for ORA_INBOUND and ORA_OUTBOUND are the same as above.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation 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)",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Number 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.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Number 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.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcOrderFulfillmentDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transacted asset in the asset transaction. Generated by the application. Read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TransactedQuantity":{
            "type":"number",
            "description":"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).",
            "nullable":true,
            "x-queryable":true
        },
        "TransactedUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation 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.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionLineType":{
            "maxLength":30,
            "type":"string",
            "description":"Type 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.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

addShipLine: Operation: /fscmRestApi/resources/11.13.18.05/customerAssetTransactions/action/addShipLine

If the action completes successfully, the respective asset transaction record is updated with the new sales order line reference and business process code.
updateShipLineQuantity: Operation: /fscmRestApi/resources/11.13.18.05/customerAssetTransactions/action/updateShipLineQuantity

If the action completes successfully, the respective asset transaction record is marked as canceled.