サブスクリプション・パーティの作成
post
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties
リクエスト
パス・パラメータ
- 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
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
contacts: array Contacts
タイトル:
Contacts
サブスクリプション・パーティの担当者を表示、作成、更新および削除するcontactsリソース。 -
InternalFlag: boolean
最大長:
1
デフォルト値:false
パーティが内部かどうかを示します。 -
PartyId(required): integer (int64)
パーティの一意識別子
-
PartyName: string
タイトル:
Name
パーティの名前。 -
PartyNumber: string
タイトル:
Party Number
パーティの代替識別子。 -
PartyPuid(required): string
最大長:
120
パーティの代替識別子。 -
PartyRole(required): string
タイトル:
Role
最大長:20
パーティのロール。 -
PrimaryFlag: boolean
タイトル:
Primary
最大長:1
デフォルト値:false
パーティがプライマリかどうかを示します。 -
SubscriptionId(required): integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionPartyId: integer (int64)
サブスクリプション・パーティの一意の識別子。
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
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)
サブスクリプション・パーティの一意の識別子。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : subscriptions-parties-item-response
タイプ:
ソースを表示
object
-
contacts: array Contacts
タイトル:
Contacts
サブスクリプション・パーティの担当者を表示、作成、更新および削除するcontactsリソース。 -
CreatedBy: string
読取り専用:
true
最大長:64
パーティを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
パーティが作成された日付。 -
InternalFlag: boolean
最大長:
1
デフォルト値:false
パーティが内部かどうかを示します。 -
LastUpdateDate: string (date-time)
読取り専用:
true
パーティが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
パーティを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
パーティを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
オブジェクト・バージョン番号。 -
PartyId: integer (int64)
パーティの一意識別子
-
PartyName: string
タイトル:
Name
パーティの名前。 -
PartyNumber: string
タイトル:
Party Number
パーティの代替識別子。 -
PartyPuid: string
最大長:
120
パーティの代替識別子。 -
PartyRole: string
タイトル:
Role
最大長:20
パーティのロール。 -
PrimaryFlag: boolean
タイトル:
Primary
最大長:1
デフォルト値:false
パーティがプライマリかどうかを示します。 -
SubscriptionId: integer (int64)
サブスクリプションの一意の識別子。
-
SubscriptionPartyId: integer (int64)
サブスクリプション・パーティの一意の識別子。
ネストされたスキーマ : 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)
サブスクリプション・パーティの一意の識別子。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- 担当者
-
パラメータ:
- PartyPuid:
$request.path.PartyPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
サブスクリプション担当者 - PartyPuid:
例:
次の例は、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/GP5678/child/parties
リクエスト本文
次に、JSON形式のリクエスト本文の内容を示します。
{ "PartyPuid": "GP-5678-PRTY-24", "PartyRole": "ORA_CUSTOMER", "PartyId": 300100070252912, "PrimaryFlag": false, "InternalFlag": false }
レスポンス本文
次に、JSON形式のレスポンス本文の内容を示します。
{ "SubscriptionPartyId": 300100177241440, "PartyPuid": "GP-5678-PRTY-24", "SubscriptionId": 300100177254423, "PartyRole": "ORA_CUSTOMER", "PartyId": 300100070252912, "PrimaryFlag": false, "InternalFlag": false, "ObjectVersionNumber": 1, "CreatedBy": "CONMGR", "CreationDate": "2019-06-04T18:39:36+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-06-04T18:39:36.173+00:00", "LastUpdateLogin": "8A5689AE12D939D9E05322EAF40A63A4", "PartyName": " Clarke James", "PartyNumber": "CDRM_154814", ... }