機械翻訳について

ジャンプ先

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

サブスクリプション担当者の作成

post

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}/child/contacts

リクエスト

パス・パラメータ

• PartyPuid(required): string
  パーティの代替識別子。
• SubscriptionNumber(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

ソースを表示

• AccessLevel: string
  最大長: 302

  担当者のアクセス・レベル。
• BillingOwnerFlag: boolean
  最大長: 1

  デフォルト値: false

  この担当者が請求所有者かどうかを示します。
• ContactEmail: string
  タイトル: Email

  担当者のEメール・アドレス。
• ContactId: integer (int64)
  担当者の一意の識別子。
• ContactName: string
  タイトル: Name

  担当者名。
• ContactNumber: string
  タイトル: Party Contact Number

  担当者番号。
• ContactPuid: string
  最大長: 120

  代替サブスクリプション担当者。
• ContactRole: string
  タイトル: Role

  最大長: 30

  担当者ロール。
• EndDate: 文字列(日付)
  担当者の終了日。
• InternalFlag: boolean
  最大長: 1

  デフォルト値: false

  この担当者が内部かどうかを示します。
• OwnerFlag: boolean
  タイトル: Owner

  最大長: 1

  デフォルト値: false

  担当者が所有者かどうかを示します。
• PartyId: integer
  パーティの一意識別子
• StartDate: 文字列(日付)
  担当者の開始日。
• SubscriptionContactId: integer (int64)
  サブスクリプション担当者の一意の識別子。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionPartyId: integer (int64)
  サブスクリプション・パーティの一意の識別子。

{
    "type":"object",
    "properties":{
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate subscription contact.",
            "nullable":false
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The contact's email address.",
            "nullable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The contact number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : subscriptions-parties-contacts-item-response

タイプ: object

ソースを表示

• AccessLevel: string
  最大長: 302

  担当者のアクセス・レベル。
• BillingOwnerFlag: boolean
  最大長: 1

  デフォルト値: false

  この担当者が請求所有者かどうかを示します。
• ContactEmail: string
  タイトル: Email

  担当者のEメール・アドレス。
• ContactId: integer (int64)
  担当者の一意の識別子。
• ContactName: string
  タイトル: Name

  担当者名。
• ContactNumber: string
  タイトル: Party Contact Number

  担当者番号。
• ContactPuid: string
  最大長: 120

  代替サブスクリプション担当者。
• ContactRole: string
  タイトル: Role

  最大長: 30

  担当者ロール。
• CreatedBy: string
  読取り専用: true

  最大長: 64

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

  担当者が作成された日付。
• EndDate: 文字列(日付)
  担当者の終了日。
• InternalFlag: boolean
  最大長: 1

  デフォルト値: false

  この担当者が内部かどうかを示します。
• LastUpdateDate: string (date-time)
  読取り専用: true

  担当者が最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  担当者を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  読取り専用: true

  オブジェクト・バージョン番号。
• OwnerFlag: boolean
  タイトル: Owner

  最大長: 1

  デフォルト値: false

  担当者が所有者かどうかを示します。
• PartyId: integer
  パーティの一意識別子
• StartDate: 文字列(日付)
  担当者の開始日。
• SubscriptionContactId: integer (int64)
  サブスクリプション担当者の一意の識別子。
• SubscriptionId: integer (int64)
  サブスクリプションの一意の識別子。
• SubscriptionPartyId: integer (int64)
  サブスクリプション・パーティの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact is the owner.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InternalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is internal or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SubscriptionPartyId":{
            "type":"integer",
            "description":"The unique identifier of the subscription party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ContactRole":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The contact role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessLevel":{
            "maxLength":302,
            "type":"string",
            "description":"The access level of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ContactPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The alternate subscription contact.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The contact's email address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Party Contact Number",
            "type":"string",
            "description":"The contact number.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillingOwnerFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this contact is a billing owner or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The contact name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the contact 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 contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionContactId":{
            "type":"integer",
            "description":"The unique identifier of the subscription contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行してサブスクリプション担当者を作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/parties/GP-5678-PRTY-9/child/contacts

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
    "ContactPuid": "GP-5678-PRTY-9-PCNT-10",
    "ContactRole": "ORA_CUSTOMER_CONTACT",
    "PartyId": 1001,
    "ContactId": 1009,
    "BillingOwnerFlag": false,
    "InternalFlag": false
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "SubscriptionContactId": 300100177241556,
    "ContactPuid": "GP-5678-PRTY-9-PCNT-10",
    "SubscriptionPartyId": 300100177254426,
    "ContactRole": "ORA_CUSTOMER_CONTACT",
    "SubscriptionId": 300100177254423,
    "PartyId": 1001,
    "ContactId": 1009,
    "StartDate": null,
    "EndDate": null,
    "AccessLevel": null,
    "BillingOwnerFlag": false,
    "InternalFlag": false,
    "ContactName": "Mike Kenton",
    "ContactEmail": null,
    "ObjectVersionNumber": 1,
    "CreatedBy": "CONMGR",
    "CreationDate": "2019-06-05T03:14:40+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2019-06-05T03:14:40.329+00:00",
    "LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4",
    ...
}

「トップに戻る」