サブスクリプション・パーティの取得
get
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}
リクエスト
パス・パラメータ
- PartyPuid(required): string
パーティの代替識別子。
- SubscriptionNumber(required): string
サブスクリプションの代替識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- 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リソースに対するGETリクエストを発行することによって、サブスクリプション・パーティを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/parties/GP-5678-PRTY-9
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "SubscriptionPartyId": 300100177254426, "PartyPuid": "GP-5678-PRTY-9", "SubscriptionId": 300100177254423, "PartyRole": "ORA_CUSTOMER", "PartyId": 1001, "PrimaryFlag": true, "InternalFlag": false, "ObjectVersionNumber": 1, "CreatedBy": "CONMGR", "CreationDate": "2019-06-04T04:25:08.026+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-06-04T04:25:08.875+00:00", "LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656", "PartyName": "A T & T SOLUTIONS INC", "PartyNumber": "1001", ... }