1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Asset Transactions

Get a subscription asset transaction

get

/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}

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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : subscriptionAssetTransactions-item-response
Type: object
Show Source
Nested Schema : Asset Fulfillment Lines
Type: array
Title: Asset Fulfillment Lines
The asset fulfillment lines resource to view and create the asset fulfillment details in a replacement or upgrade transaction. The Asset Fulfillment Lines object has details such as replaced or upgraded customer asset, fulfillment date, fulfillment type etc.
Show Source
Nested Schema : Asset Split Lines
Type: array
Title: Asset Split Lines
The asset split lines resource to is used view and create the asset split details in a split transaction. The Asset Split Lines object has details such as customer asset, quantity etc.
Show Source
Nested Schema : subscriptionAssetTransactions-AssetFulfillmentLines-item-response
Type: object
Show Source
Nested Schema : subscriptionAssetTransactions-AssetSplitLines-item-response
Type: object
Show Source
Links
AssetFulfillmentLines
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
The asset fulfillment lines resource to view and create the asset fulfillment details in a replacement or upgrade transaction. The Asset Fulfillment Lines object has details such as replaced or upgraded customer asset, fulfillment date, fulfillment type etc.
AssetSplitLines
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
The asset split lines resource to is used view and create the asset split details in a split transaction. The Asset Split Lines object has details such as customer asset, quantity etc.
notifyFulfillmentCompleted
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
This method will be used for notifying the completion of fulfillment in case of customer replacement or upgrade transaction.
notifyPendingFulfillmentCancelled
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
This method will be used for notifying the fulfillment is cancelled in case of customer replacement or upgrade transaction.
notifyReturnCompleted
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
This method will be used for notifying the completion of return in case of customer replacement or upgrade transaction.
notifyShipmentCompleted
Parameters:
  • TransactionNumber: $request.path.TransactionNumber
Notifies the completion of shipment in case of customer replacement or upgrade transaction.
Back to Top

Examples

The following example shows how to get a subscription asset transaction by submitting a GET request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "TransactionId": 100100132581487,
    "TransactionNumber": "ATXN-1002",
    "TransactionSequence": 1002,
    "TransactionType": "CUSTOMER_ASSET_CREATION",
    "TransactionDate": "2019-12-09",
    "TransactionStatus": "PROCESSED",
    "AssetId": 300100185258462,
    "Quantity": 1,
    "BusinessUnitId": null,
    "CustomerId": 1005,
    "BillToAccountId": 1005,
    "BillToAccountSiteId": null,
    "BillToAccountSiteUseId": 1023,
    "ShipToPartyId": null,
    "ShipToPartySiteId": null,
    "SalesOrderSystem": "CSV",
    "SalesOrderId": 43931,
    "SalesOrderLineId": 43931,
    "SalesOrderNumber": "43931",
    "SalesOrderLineNumber": "43931",
    "ReturnOrderSystem": null,
    "ReturnOrderId": null,
    "ReturnOrderLineId": null,
    "ReturnOrderNumber": null,
    "ReturnOrderLineNumber": null,
    "ReplacementAssetId": null,
    "FulfillmentType": null,
    "WaitForFulfillment": null,
    "PendingFulfillmentCancelled": null,
    "ShipmentCompleted": null,
    "ReturnCompleted": null,
    "CreatedBy": "ALM_QA",
    "CreationDate": "2019-12-10T12:27:25+00:00",
    "LastUpdatedBy": "ALM_QA",
    "LastUpdateDate": "2019-12-10T12:27:25+00:00",
    "LastUpdateLogin": "991B01E9868C8305E0533CFDF40ACD30",
    "links": [
....
}
Back to Top