機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

サブスクリプション・アセット・トランザクションの作成

post

/crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• AssetFulfillmentLines: array Asset Fulfillment Lines
  タイトル: Asset Fulfillment Lines

  置換またはアップグレード・トランザクションでアセット履行詳細を表示および作成するアセット履行明細リソースです。 アセット履行明細オブジェクトには、置換またはアップグレードされた顧客アセット、履行日、履行タイプなどの詳細があります。
• AssetId(required): integer (int64)
  トランザクションに関連付けられたアセットの一意の識別子。
• AssetSplitLines: array Asset Split Lines
  タイトル: Asset Split Lines

  使用されるアセット分割明細リソースは、分割トランザクションでアセット分割詳細を表示および作成します。 アセット分割明細オブジェクトには、顧客アセット、数量などの詳細があります。
• BillToAccountId: integer (int64)
  アセットに関連付けられた請求先アカウントの一意の識別子。
• BillToAccountSiteId: integer (int64)
  アセットに関連付けられている請求先アカウント・サイトの一意の識別子。
• BillToAccountSiteUseId: integer (int64)
  アセットに関連付けられた請求先アカウント・サイト使用の一意の識別子。
• BusinessUnitId: integer (int64)
  アセットに関連付けられているビジネス・ユニットの一意の識別子。
• CustomerId: integer (int64)
  アセットに関連付けられている顧客の一意の識別子。
• FulfillmentType: string
  最大長: 30

  履行のタイプ。
• 数量: number
  トランザクションの四半期。
• ReplacementAssetId: integer (int64)
  置換アセットの一意の識別子。
• ReturnOrderId: integer (int64)
  返品オーダーのID。
• ReturnOrderLineId: integer (int64)
  返品オーダーの個別の明細ID。
• ReturnOrderLineNumber: string
  最大長: 120

  返品オーダー明細番号。
• ReturnOrderNumber: string
  最大長: 120

  返品オーダーの識別子。
• ReturnOrderSystem: string
  最大長: 30

  返品オーダーの追跡に使用されるシステム。
• SalesOrderId: integer (int64)
  販売オーダーの一意の識別子。
• SalesOrderLineId: integer (int64)
  販売オーダーの明細の一意識別子です。
• SalesOrderLineNumber: string
  最大長: 120

  オーダーのライン番号。
• SalesOrderNumber: string
  最大長: 120

  販売オーダーの代替一意識別子。
• SalesOrderSystem: string
  最大長: 30

  トランザクションに関連付けられている販売オーダー・システム。
• ShipToPartyId: integer (int64)
  アセットに関連付けられた出荷先アカウントの一意の識別子。
• ShipToPartySiteId: integer (int64)
  アセットに関連付けられた出荷先アカウント・サイトの一意の識別子。
• TransactionDate(required): 文字列(日付)
  タイトル: Transaction Date

  トランザクションの日付。
• TransactionId: integer (int64)
  トランザクションの一意の識別子。
• TransactionType(required): string
  タイトル: Asset Transaction Type

  最大長: 60

  トランザクションのタイプ。
• WaitForFulfillment: string
  最大長: 1

  サブスクリプションの履行に必要な時間。

{
    "required":[
        "AssetId",
        "TransactionDate",
        "TransactionType"
    ],
    "type":"object",
    "properties":{
        "TransactionType":{
            "title":"Asset Transaction Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BillToAccountSiteUseId":{
            "type":"integer",
            "description":"The unique identifier of the bill-to account site use associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "ShipToPartyId":{
            "type":"integer",
            "description":"The unique identifier of the ship-to account associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "ReturnOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the return order.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "SalesOrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The sales order system associated with the transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ReturnOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The return order line number.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"The unique identifier of the sales order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "ReturnOrderLineId":{
            "type":"integer",
            "description":"The individual line ID of the return order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"The unique identifier of the line in the sales order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SalesOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The line number of the sles order.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ReturnOrderId":{
            "type":"integer",
            "description":"The ID of the return order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "WaitForFulfillment":{
            "maxLength":1,
            "type":"string",
            "description":"The time required to fulfil the subscription.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date for the transaction.",
            "format":"date",
            "nullable":false
        },
        "FulfillmentType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of fulfillment.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AssetSplitLines":{
            "title":"Asset Split Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetSplitLines-item-post-request"
            }
        },
        "ReturnOrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The system used to track return orders.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "Quantity":{
            "type":"number",
            "description":"The quatity for the transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AssetFulfillmentLines":{
            "title":"Asset Fulfillment Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetFulfillmentLines-item-post-request"
            }
        },
        "CustomerId":{
            "type":"integer",
            "description":"The unique identifier of the customer associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SalesOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the sales order.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ShipToPartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the ship-to account site associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "ReplacementAssetId":{
            "type":"integer",
            "description":"The unique identifier of the replacement asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "BillToAccountId":{
            "type":"integer",
            "description":"The unique identifier of the bill-to account associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "BillToAccountSiteId":{
            "type":"integer",
            "description":"The unique identifier of the bill-to account site associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : アセット履行明細

タイプ: array

タイトル: Asset Fulfillment Lines

置換またはアップグレード・トランザクションでアセット履行詳細を表示および作成するアセット履行明細リソースです。 アセット履行明細オブジェクトには、置換またはアップグレードされた顧客アセット、履行日、履行タイプなどの詳細があります。

ソースを表示

• Array of: object schema

{
    "title":"Asset Fulfillment Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetFulfillmentLines-item-post-request"
    }
}

ネストされたスキーマ : アセット分割明細

タイプ: array

タイトル: Asset Split Lines

使用されるアセット分割明細リソースは、分割トランザクションでアセット分割詳細を表示および作成します。 アセット分割明細オブジェクトには、顧客アセット、数量などの詳細があります。

ソースを表示

• Array of: object schema

{
    "title":"Asset Split Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetSplitLines-item-post-request"
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• AssetId: integer (int64)
  関連付けられたアセットの一意の識別子。
• FulfillmentLineDate: 文字列(日付)
  履行明細の日付。
• FulfillmentLineId: integer (int64)
  履行明細の一意の識別子。
• FulfillmentLineType: string
  最大長: 30

  履行タイプのタイプ。
• OrderFulfillLineId: integer (int64)
  オーダー履行明細の一意の識別子。
• OrderId: integer (int64)
  システム内のオーダーの一意の識別子。
• OrderLineId: integer (int64)
  システム内のオーダー明細の一意の識別子。
• OrderLineNumber: string
  最大長: 120

  オーダー明細の代替一意識別子。
• OrderNumber: string
  最大長: 120

  オーダーの代替一意識別子。
• OrderSystem: string
  最大長: 30

  関連付けられているオーダー・システム。
• 数量: number
  履行明細のアセットの数量です。

{
    "type":"object",
    "properties":{
        "OrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order line.",
            "nullable":true
        },
        "FulfillmentLineId":{
            "type":"integer",
            "description":"The unique identifier of the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrderLineId":{
            "type":"integer",
            "description":"The unique identifier of the order line in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FulfillmentLineType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the fullfillment type.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the asset in the fulfillment line.",
            "nullable":true
        },
        "OrderFulfillLineId":{
            "type":"integer",
            "description":"The unique identifier of the order fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order.",
            "nullable":true
        },
        "FulfillmentLineDate":{
            "type":"string",
            "description":"The date of the fulfillment line.",
            "format":"date",
            "nullable":true
        },
        "OrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The order system associated.",
            "nullable":true
        },
        "OrderId":{
            "type":"integer",
            "description":"The unique identifier of the order in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : スキーマ

タイプ: object

ソースを表示

• AssetId: integer (int64)
  トランザクションに関連付けられたアセットの一意の識別子。
• 数量: number
  履行明細のアセットの数量です。
• SplitLineId: integer (int64)
  分割明細の一意の識別子。

{
    "type":"object",
    "properties":{
        "Quantity":{
            "type":"number",
            "description":"The quantity of the asset in the fulfillment line.",
            "nullable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SplitLineId":{
            "type":"integer",
            "description":"The unique identifier of the split line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : subscriptionAssetTransactions-item-response

タイプ: object

ソースを表示

• AssetFulfillmentLines: array Asset Fulfillment Lines
  タイトル: Asset Fulfillment Lines

  置換またはアップグレード・トランザクションでアセット履行詳細を表示および作成するアセット履行明細リソースです。 アセット履行明細オブジェクトには、置換またはアップグレードされた顧客アセット、履行日、履行タイプなどの詳細があります。
• AssetId: integer (int64)
  トランザクションに関連付けられたアセットの一意の識別子。
• AssetSplitLines: array Asset Split Lines
  タイトル: Asset Split Lines

  使用されるアセット分割明細リソースは、分割トランザクションでアセット分割詳細を表示および作成します。 アセット分割明細オブジェクトには、顧客アセット、数量などの詳細があります。
• BillToAccountId: integer (int64)
  アセットに関連付けられた請求先アカウントの一意の識別子。
• BillToAccountSiteId: integer (int64)
  アセットに関連付けられている請求先アカウント・サイトの一意の識別子。
• BillToAccountSiteUseId: integer (int64)
  アセットに関連付けられた請求先アカウント・サイト使用の一意の識別子。
• BusinessUnitId: integer (int64)
  アセットに関連付けられているビジネス・ユニットの一意の識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• CustomerId: integer (int64)
  アセットに関連付けられている顧客の一意の識別子。
• FulfillmentType: string
  最大長: 30

  履行のタイプ。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PendingFulfillmentCancelled: string
  読取り専用: true

  最大長: 1

  保留履行を取り消すことができるかどうかを示します。
• 数量: number
  トランザクションの四半期。
• ReplacementAssetId: integer (int64)
  置換アセットの一意の識別子。
• ReturnCompleted: string
  読取り専用: true

  最大長: 1

  返品が完了したかどうかを示します。
• ReturnOrderId: integer (int64)
  返品オーダーのID。
• ReturnOrderLineId: integer (int64)
  返品オーダーの個別の明細ID。
• ReturnOrderLineNumber: string
  最大長: 120

  返品オーダー明細番号。
• ReturnOrderNumber: string
  最大長: 120

  返品オーダーの識別子。
• ReturnOrderSystem: string
  最大長: 30

  返品オーダーの追跡に使用されるシステム。
• SalesOrderId: integer (int64)
  販売オーダーの一意の識別子。
• SalesOrderLineId: integer (int64)
  販売オーダーの明細の一意識別子です。
• SalesOrderLineNumber: string
  最大長: 120

  オーダーのライン番号。
• SalesOrderNumber: string
  最大長: 120

  販売オーダーの代替一意識別子。
• SalesOrderSystem: string
  最大長: 30

  トランザクションに関連付けられている販売オーダー・システム。
• ShipmentCompleted: string
  読取り専用: true

  最大長: 1

  出荷が完了したかどうかを示します。
• ShipToPartyId: integer (int64)
  アセットに関連付けられた出荷先アカウントの一意の識別子。
• ShipToPartySiteId: integer (int64)
  アセットに関連付けられた出荷先アカウント・サイトの一意の識別子。
• TransactionDate: 文字列(日付)
  タイトル: Transaction Date

  トランザクションの日付。
• TransactionId: integer (int64)
  トランザクションの一意の識別子。
• TransactionNumber: string
  読取り専用: true

  最大長: 120

  トランザクションの代替一意識別子。
• TransactionSequence: integer (int64)
  タイトル: Sequence

  読取り専用: true

  トランザクションに関連付けられた連番。
• TransactionStatus: string
  タイトル: Status

  読取り専用: true

  最大長: 30

  デフォルト値: NEW

  トランザクションのcurrnetステータス。
• TransactionType: string
  タイトル: Asset Transaction Type

  最大長: 60

  トランザクションのタイプ。
• WaitForFulfillment: string
  最大長: 1

  サブスクリプションの履行に必要な時間。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Asset Transaction Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BillToAccountSiteUseId":{
            "type":"integer",
            "description":"The unique identifier of the bill-to account site use associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The currnet status of the transaction.",
            "nullable":false,
            "readOnly":true,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReturnCompleted":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the return is complete.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ShipToPartyId":{
            "type":"integer",
            "description":"The unique identifier of the ship-to account associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ReturnOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the return order.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SalesOrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The sales order system associated with the transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ReturnOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The return order line number.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"The unique identifier of the sales order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ReturnOrderLineId":{
            "type":"integer",
            "description":"The individual line ID of the return order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"The unique identifier of the line in the sales order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The line number of the sles order.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ReturnOrderId":{
            "type":"integer",
            "description":"The ID of the return order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence associated with the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WaitForFulfillment":{
            "maxLength":1,
            "type":"string",
            "description":"The time required to fulfil the subscription.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date for the transaction.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FulfillmentType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of fulfillment.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AssetSplitLines":{
            "title":"Asset Split Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetSplitLines-item-response"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ReturnOrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The system used to track return orders.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quatity for the transaction.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AssetFulfillmentLines":{
            "title":"Asset Fulfillment Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetFulfillmentLines-item-response"
            }
        },
        "ShipmentCompleted":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the shipment is complete.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"The unique identifier of the customer associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the sales order.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ShipToPartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the ship-to account site associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PendingFulfillmentCancelled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the pendinf fulfillment can be cancelled.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ReplacementAssetId":{
            "type":"integer",
            "description":"The unique identifier of the replacement asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "BillToAccountId":{
            "type":"integer",
            "description":"The unique identifier of the bill-to account associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "BillToAccountSiteId":{
            "type":"integer",
            "description":"The unique identifier of the bill-to account site associated with the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アセット履行明細

タイプ: array

タイトル: Asset Fulfillment Lines

置換またはアップグレード・トランザクションでアセット履行詳細を表示および作成するアセット履行明細リソースです。 アセット履行明細オブジェクトには、置換またはアップグレードされた顧客アセット、履行日、履行タイプなどの詳細があります。

ソースを表示

• Array of: object subscriptionAssetTransactions-AssetFulfillmentLines-item-response

{
    "title":"Asset Fulfillment Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetFulfillmentLines-item-response"
    }
}

ネストされたスキーマ : アセット分割明細

タイプ: array

タイトル: Asset Split Lines

使用されるアセット分割明細リソースは、分割トランザクションでアセット分割詳細を表示および作成します。 アセット分割明細オブジェクトには、顧客アセット、数量などの詳細があります。

ソースを表示

• Array of: object subscriptionAssetTransactions-AssetSplitLines-item-response

{
    "title":"Asset Split Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionAssetTransactions-AssetSplitLines-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : subscriptionAssetTransactions-AssetFulfillmentLines-item-response

タイプ: object

ソースを表示

• AssetId: integer (int64)
  関連付けられたアセットの一意の識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• FulfillmentLineDate: 文字列(日付)
  履行明細の日付。
• FulfillmentLineId: integer (int64)
  履行明細の一意の識別子。
• FulfillmentLineNumber: string
  読取り専用: true

  最大長: 120

  履行明細の識別子。
• FulfillmentLineType: string
  最大長: 30

  履行タイプのタイプ。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrderFulfillLineId: integer (int64)
  オーダー履行明細の一意の識別子。
• OrderId: integer (int64)
  システム内のオーダーの一意の識別子。
• OrderLineId: integer (int64)
  システム内のオーダー明細の一意の識別子。
• OrderLineNumber: string
  最大長: 120

  オーダー明細の代替一意識別子。
• OrderNumber: string
  最大長: 120

  オーダーの代替一意識別子。
• OrderSystem: string
  最大長: 30

  関連付けられているオーダー・システム。
• 数量: number
  履行明細のアセットの数量です。

{
    "type":"object",
    "properties":{
        "FulfillmentLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The identifier of the fulfillment line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order line.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FulfillmentLineType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the fullfillment type.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the asset in the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the order.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderId":{
            "type":"integer",
            "description":"The unique identifier of the order in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FulfillmentLineId":{
            "type":"integer",
            "description":"The unique identifier of the fulfillment line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderLineId":{
            "type":"integer",
            "description":"The unique identifier of the order line in the system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderFulfillLineId":{
            "type":"integer",
            "description":"The unique identifier of the order fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FulfillmentLineDate":{
            "type":"string",
            "description":"The date of the fulfillment line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrderSystem":{
            "maxLength":30,
            "type":"string",
            "description":"The order system associated.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the associated asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

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

ネストされたスキーマ : subscriptionAssetTransactions-AssetSplitLines-item-response

タイプ: object

ソースを表示

• AssetId: integer (int64)
  トランザクションに関連付けられたアセットの一意の識別子。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  レコードが作成された日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• 数量: number
  履行明細のアセットの数量です。
• SplitLineId: integer (int64)
  分割明細の一意の識別子。
• SplitLineNumber: string
  読取り専用: true

  最大長: 120

  分割明細の代替一意識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitLineNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the split line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitLineId":{
            "type":"integer",
            "description":"The unique identifier of the split line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the asset in the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

リンク

AssetFulfillmentLines

操作: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetFulfillmentLines

パラメータ:

• TransactionNumber: $request.path.TransactionNumber

置換またはアップグレード・トランザクションでアセット履行詳細を表示および作成するアセット履行明細リソースです。 アセット履行明細オブジェクトには、置換またはアップグレードされた顧客アセット、履行日、履行タイプなどの詳細があります。

AssetSplitLines

操作: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/child/AssetSplitLines

パラメータ:

• TransactionNumber: $request.path.TransactionNumber

使用されるアセット分割明細リソースは、分割トランザクションでアセット分割詳細を表示および作成します。 アセット分割明細オブジェクトには、顧客アセット、数量などの詳細があります。

notifyFulfillmentCompleted

操作: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyFulfillmentCompleted

パラメータ:

• TransactionNumber: $request.path.TransactionNumber

このメソッドは、顧客交換またはアップグレード・トランザクションの場合に履行の完了を通知するために使用されます。

notifyPendingFulfillmentCancelled

操作: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyPendingFulfillmentCancelled

パラメータ:

• TransactionNumber: $request.path.TransactionNumber

このメソッドは、顧客置換またはアップグレード・トランザクションの場合に履行が取り消されたことを通知するために使用されます。

notifyReturnCompleted

操作: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyReturnCompleted

パラメータ:

• TransactionNumber: $request.path.TransactionNumber

このメソッドは、顧客交換またはアップグレード・トランザクションの場合に返品の完了を通知するために使用されます。

notifyShipmentCompleted

操作: /crmRestApi/resources/11.13.18.05/subscriptionAssetTransactions/{TransactionNumber}/action/notifyShipmentCompleted

パラメータ:

• TransactionNumber: $request.path.TransactionNumber

顧客置換またはアップグレード・トランザクションの場合に出荷の完了を通知します。

トップに戻る

例:

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

cURLコマンド

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

リクエスト本文の例

次に、JSON形式のリクエスト本文の内容を示します。

{
"TransactionType": "CUSTOMER_ASSET_CREATION",
"TransactionDate": "2020-07-01",  
"AssetId": 300100185258462,
"Quantity": 1,
"CustomerId": 1005,
"BillToAccountId": 1005,
"BillToAccountSiteUseId":1023,
"SalesOrderSystem": "CSV",
"SalesOrderId": "1000",
"SalesOrderLineId": 1000,
"SalesOrderNumber": "1",
"SalesOrderLineNumber": 1
}

レスポンス本文の例

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

{
    "TransactionId": 300100553691636,
    "TransactionNumber": "ATXN-3002",
    "TransactionSequence": 3001,
    "TransactionType": "CUSTOMER_ASSET_CREATION",
    "TransactionDate": "2020-07-01",
    "TransactionStatus": "PENDING",
    "AssetId": 300100185258462,
    "Quantity": 1,
    "BusinessUnitId": null,
    "CustomerId": 1005,
    "BillToAccountId": 1005,
    "BillToAccountSiteId": null,
    "BillToAccountSiteUseId": 1023,
    "ShipToPartyId": null,
    "ShipToPartySiteId": null,
    "SalesOrderSystem": "CSV",
    "SalesOrderId": 1000,
    "SalesOrderLineId": 1000,
    "SalesOrderNumber": "1",
    "SalesOrderLineNumber": "1",
    "ReturnOrderSystem": null,
    "ReturnOrderId": null,
    "ReturnOrderLineId": null,
    "ReturnOrderNumber": null,
    "ReturnOrderLineNumber": null,
    "ReplacementAssetId": null,
    "FulfillmentType": null,
    "WaitForFulfillment": null,
    "PendingFulfillmentCancelled": null,
    "ShipmentCompleted": null,
    "ReturnCompleted": null,
    "CreatedBy": "CONMGR",
    "CreationDate": "2021-03-09T06:02:06+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2021-03-09T06:02:06.783+00:00",
    "LastUpdateLogin": "BC547B379746472FE0530740F00AC04A",

...
}

「トップに戻る」