機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. サブスクリプション・アセット・トランザクション

すべてのサブスクリプション・アセット・トランザクションを取得

get

/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • AltKey : 指定したトランザクション番号を持つサブスクリプション・アセット・トランザクションを検索
      ファインダ変数:
      • TransactionNumber; string;トランザクションの代替の一意の識別子。
    • PrimaryKey : 指定したトランザクション識別子を持つサブスクリプション・アセット・トランザクションを検索
      ファインダ変数:
      • TransactionId; integer;トランザクションの一意の識別子。
    • SubscriptionAssetTransactionByNumber : 指定したトランザクション番号を持つサブスクリプション・アセット・トランザクションを検索
      ファインダ変数:
      • TransactionNumber; string;トランザクションの代替の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AssetId; integer; トランザクションに関連付けられている資産の一意の識別子。
    • BillToAccountId; integer; アセットに関連付けられた請求先アカウントの一意の識別子。
    • BillToAccountSiteId; integer; アセットに関連付けられている請求先アカウント・サイトの一意の識別子。
    • BillToAccountSiteUseId; integer;アセットに関連付けられた請求先アカウント・サイト使用の一意の識別子。
    • BusinessUnitId; integer; アセットに関連付けられたビジネス・ユニットの一意の識別子。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CustomerId; integer; アセットに関連付けられた顧客の一意の識別子。
    • FulfillmentType; string;履行のタイプ。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • PendingFulfillmentCancelled; string; pendinf履行を取消できるかどうかを示します。
    • 数量、数値、トランザクションのquatity。
    • ReplacementAssetId; integer;置換アセットの一意の識別子。
    • ReturnCompleted; string;戻り値が完全であるかどうかを示します。
    • ReturnOrderId; integer;戻り順序のID。
    • ReturnOrderLineId; integer;返品オーダーの個別の行ID。
    • ReturnOrderLineNumber; string;返品オーダー行番号。
    • ReturnOrderNumber; string;戻り順序の識別子。
    • ReturnOrderSystem; string;返品オーダーの追跡に使用されるシステム。
    • SalesOrderId; integer;販売オーダーの一意の識別子。
    • SalesOrderLineId; integer;販売オーダーの明細の一意の識別子。
    • SalesOrderLineNumber; string; sles順序の行番号。
    • SalesOrderNumber; string;販売オーダーの代替一意識別子。
    • SalesOrderSystem; string;トランザクションに関連付けられた販売オーダー・システム。
    • ShipToPartyId; integer; アセットに関連付けられた出荷先アカウントの一意の識別子。
    • ShipToPartySiteId; integer; アセットに関連付けられた出荷先アカウント・サイトの一意の識別子。
    • ShipmentCompleted; string; 出荷が完了したかどうかを示します。
    • TransactionDate; string;トランザクションの日付。
    • TransactionId; integer;トランザクションの一意の識別子。
    • TransactionNumber; string;トランザクションの代替の一意の識別子。
    • TransactionSequence; integer;トランザクションに関連付けられた順序。
    • TransactionStatus; string;トランザクションのcurrnetステータス。
    • TransactionType; string;トランザクションのタイプ。
    • WaitForFulfillment; string; サブスクリプションを履行するために必要な時間。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : subscriptionAssetTransactions
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : subscriptionAssetTransactions-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : アセット履行明細
タイプ: array
タイトル: Asset Fulfillment Lines
置換またはアップグレード・トランザクションでアセット履行詳細を表示および作成するアセット履行明細リソースです。 アセット履行明細オブジェクトには、置換またはアップグレードされた顧客アセット、履行日、履行タイプなどの詳細があります。
ソースを表示
ネストされたスキーマ : アセット分割明細
タイプ: array
タイトル: Asset Split Lines
使用されるアセット分割明細リソースは、分割トランザクションでアセット分割詳細を表示および作成します。 アセット分割明細オブジェクトには、顧客アセット、数量などの詳細があります。
ソースを表示
ネストされたスキーマ : subscriptionAssetTransactions-AssetFulfillmentLines-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : subscriptionAssetTransactions-AssetSplitLines-item-response
タイプ: object
ソースを表示
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのサブスクリプション・アセット・トランザクションを取得する方法を示しています。

cURLコマンド

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

レスポンス本文の例

次に、JSON形式のレスポンス本文の内容を示します。

{
    "items": [
        {
            "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": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002",
                    "name": "subscriptionAssetTransactions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002",
                    "name": "subscriptionAssetTransactions",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/lov/TransactionTypeVA",
                    "name": "TransactionTypeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/lov/TransactionStatusVA",
                    "name": "TransactionStatusVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/child/AssetFulfillmentLines",
                    "name": "AssetFulfillmentLines",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/child/AssetSplitLines",
                    "name": "AssetSplitLines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/action/notifyShipmentCompleted",
                    "name": "notifyShipmentCompleted",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/action/notifyReturnCompleted",
                    "name": "notifyReturnCompleted",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/action/notifyPendingFulfillmentCancelled",
                    "name": "notifyPendingFulfillmentCancelled",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/ATXN-1002/action/notifyFulfillmentCompleted",
                    "name": "notifyFulfillmentCompleted",
                    "kind": "other"
                }
            ]
        },
        {
            "TransactionId": 100100132581544,
            "TransactionNumber": "ATXN-1003",
            "TransactionSequence": 1003,
            "TransactionType": "CUSTOMER_ASSET_CREATION",
            "TransactionDate": "2019-12-10",
            "TransactionStatus": "PROCESSED",
            "AssetId": 300100185258467,
            "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:33:11+00:00",
            "LastUpdatedBy": "ALM_QA",
            "LastUpdateDate": "2019-12-10T12:33:11+00:00",
            "LastUpdateLogin": "991B01E9868C8305E0533CFDF40ACD30",
...
}
「トップに戻る」