機械翻訳について

ジャンプ先

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

サブスクリプション・アカウント関係の作成

post

/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship

リクエスト

パス・パラメータ

• SubscrAccountNumber(required): string
  サブスクリプション・アカウントの代替一意識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• Comments: string
  タイトル: Comments

  最大長: 2000

  サブスクリプション・アカウント関係のコメント。
• CorpCurrencyCode: string
  タイトル: Corporate Currency Code

  最大長: 15

  サブスクリプション・アカウント関係に関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• CurrencyCode: string
  タイトル: Currency Code

  最大長: 15

  レコードが作成された日付。
• PartyId: integer (int64)
  タイトル: Sales Account ID

  パーティの一意識別子
• PartyNumber: string
  タイトル: Registry ID

  最大長: 30

  レコードの代替識別子。
• RelationshipType: string
  タイトル: Relationship Type

  最大長: 30

  関係のタイプ。
• SubscriptionAccountId: integer (int64)
  タイトル: Subscription Account ID

  サブスクリプション・アカウントの一意の識別子。
• SubscriptionAccountRelationshipNumber: string
  タイトル: Subscription Account Relationship Number

  最大長: 30

  サブスクリプション・アカウント関係の代替識別子。

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the record.",
            "nullable":false
        },
        "PartyId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionAccountRelationshipNumber":{
            "title":"Subscription Account Relationship Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the subscription account relationship.",
            "nullable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The comments for subscription account relationship.",
            "nullable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartyId",
                    "PartyNumber",
                    "PartyType"
                ]
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the subscription account relationship. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : subscriptionAccounts-subscriptionAccountRelationship-item-response

タイプ: object

ソースを表示

• Comments: string
  タイトル: Comments

  最大長: 2000

  サブスクリプション・アカウント関係のコメント。
• ContactId: integer
  タイトル: Contact ID

  読取り専用: true

  担当者の一意の識別子。
• CorpCurrencyCode: string
  タイトル: Corporate Currency Code

  最大長: 15

  サブスクリプション・アカウント関係に関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• CurrencyCode: string
  タイトル: Currency Code

  最大長: 15

  レコードが作成された日付。
• DeleteFlag: boolean
  読取り専用: true

  サブスクリプション・アカウントの通貨換算のレート。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  アカウント関係を削除できるかどうかを示します。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザーのログイン。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードが最後に更新された日付。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PartyId: integer (int64)
  タイトル: Sales Account ID

  パーティの一意識別子
• PartyName: string
  タイトル: Name

  読取り専用: true

  最大長: 360

  パーティの名前。
• PartyNumber: string
  タイトル: Registry ID

  最大長: 30

  レコードの代替識別子。
• PartyType: string
  タイトル: Party Type

  読取り専用: true

  最大長: 30

  パーティのタイプ。
• RelationshipType: string
  タイトル: Relationship Type

  最大長: 30

  関係のタイプ。
• RelationshipTypeLookup: string
  タイトル: Relationship Type Lookup Code

  読取り専用: true

  サブスクリプション・アカウント関係に関連付けられた関係タイプ参照。 パーティ・タイプに基づいてRelationshipTypeフィールドの参照コードを公開するために使用されます。
• SalesAccountId: integer
  タイトル: Sales Account ID

  読取り専用: true

  販売アカウントの一意の識別子。
• SubscrAccountNumber: string
  タイトル: Subscription Account Number

  読取り専用: true

  最大長: 30

  サブスクリプション・アカウントの代替識別子。
• SubscriptionAccountId: integer (int64)
  タイトル: Subscription Account ID

  サブスクリプション・アカウントの一意の識別子。
• SubscriptionAccountRelationshipId: integer (int64)
  タイトル: Subscription Account Relationship ID

  読取り専用: true

  サブスクリプション・アカウント関係の一意の識別子。
• SubscriptionAccountRelationshipNumber: string
  タイトル: Subscription Account Relationship Number

  最大長: 30

  サブスクリプション・アカウント関係の代替識別子。
• UpdateFlag: boolean
  読取り専用: true

  レコードを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionAccountRelationshipNumber":{
            "title":"Subscription Account Relationship Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the subscription account relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The comments for subscription account relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PartyId",
                    "PartyNumber",
                    "PartyType"
                ]
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubscriptionAccountRelationshipId":{
            "title":"Subscription Account Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account relationship.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"The rate of currency conversion for a subscription account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipTypeLookup":{
            "title":"Relationship Type Lookup Code",
            "type":"string",
            "description":"The relationship type lookup associated with the subscription account relationship. It's used to expose the Lookup code of RelationshipType field based on Party Type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyType"
                ]
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionAccountId":{
            "title":"Subscription Account ID",
            "type":"integer",
            "description":"The unique identifier of the subscription account.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the subscription account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the subscription account relationship. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Indicates whether the account relationship can be deleted.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesAccountId":{
            "title":"Sales Account ID",
            "type":"integer",
            "description":"The unique identifier of the sales account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

リンク

OrganizationVA

操作: /crmRestApi/resources/11.13.18.05/accounts

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: SalesAccountId;ターゲット属性: PartyId
• 表示属性: PartyUniqueName

PersonVA

操作: /crmRestApi/resources/11.13.18.05/contacts

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ContactId;ターゲット属性: PartyId
• 表示属性: ContactName

RelationshipTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3D{RelationshipTypeLookup}

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: RelationshipType;ターゲット属性: LookupCode
• 表示属性: 意味

「トップに戻る」