すべてのリソース・メンバーの取得
get
/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/resourceMembers
リクエスト
パス・パラメータ
- QueueId(required): integer(int64)
キューの一意の識別子。
問合せパラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 指定された主キーを持つリソース・メンバーを検索します。
ファインダ変数:- QueueResourceId; integer;リソース・メンバーの一意の識別子。
- QueueResourcePartyAltKeyFinder: 指定されたパブリック一意識別子を持つリソースを検索します。ただし、指定されたパブリック一意識別子によって識別されるキューに関連付けられている場合のみです。
ファインダ変数:- PartyNumber; string.
- QueueNumber; string;キューの公開一意識別子。
- PrimaryKey : 指定された主キーを持つリソース・メンバーを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; リソースをキューのメンバーとして追加したユーザー。
- CreationDate; string; キュー・リソース・メンバーが作成された日時。
- EmailAddress; string; リソース・メンバーの電子メール・アドレス。
- EnabledFlag; boolean。キュー・リソース・メンバーが有効かどうかを示します。 有効な場合、値はtrueで、それ以外の場合はfalseです。 デフォルト値はtrueです。
- LastUpdateDate; string; キュー・リソース・メンバーが最後に更新された日時。
- LastUpdateLogin; string; キュー・リソース・メンバーを最後に更新したユーザーに関連付けられたアプリケーション・ログイン。
- LastUpdatedBy; string; キュー・リソース・メンバーを最後に更新したユーザー。
- ObjectId; integer; キュー・リソース・メンバーとして追加された個々のリソースの一意の識別子。
- ObjectTypeCd; string; リソースが個人かチームかを示すコード。
- PartyId; integer; キュー・リソース・メンバーに関連付けられたパーティ・レコードの一意の識別子。
- PartyName; string;キュー・リソース・メンバーの名前。
- PartyNumber; string; キュー・リソース・メンバーに関連付けられたパーティ・レコードの公開一意識別子。
- PartyUniqueName; string; キュー・リソース・メンバーに関連付けられたパーティ・レコードの一意の名前。
- QueueId; integer;キューの一意の識別子。
- QueueName; string; このリソースが関連付けられているキューの名前。
- QueueNumber; string; このリソースが関連付けられているキューの公開一意識別子。
- QueueResourceId; integer; キュー・リソース・メンバーの一意の識別子。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : queues-resourceMembers
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : queues-resourceMembers-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
リソースをキューのメンバーとして追加したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
キュー・リソース・メンバーが作成された日時。 -
DeleteFlag: boolean
タイトル:
Can Delete
読取り専用:true
リソース・メンバーを削除できるかどうかを示します。 デフォルト値はtrueです。 -
EmailAddress: string
タイトル:
Email
読取り専用:true
最大長:320
リソース・メンバーの電子メール・アドレス。 -
EnabledFlag: boolean
タイトル:
Enabled
最大長:1
デフォルト値:true
キュー・リソース・メンバーが有効かどうかを示します。 有効な場合、値はtrueで、それ以外の場合はfalseです。 デフォルト値はtrueです。 -
FormattedPhoneNumber: string
タイトル:
Phone
読取り専用: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
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectId: integer (int64)
タイトル:
Resource Member ID
キュー・リソース・メンバーとして追加された個々のリソースの一意の識別子。 -
ObjectTypeCd: string
タイトル:
Queue ResourceType
読取り専用:true
最大長:30
デフォルト値:ORA_SVC_RESOURCE
リソースが個人かチームかを示すコード。 -
PartyId: integer (int64)
読取り専用:
true
キュー・リソース・メンバーに関連付けられたパーティ・レコードの一意の識別子。 -
PartyName: string
タイトル:
Name
読取り専用:true
最大長:360
キュー・リソース・メンバーの名前。 -
PartyNumber: string
読取り専用:
true
最大長:30
キュー・リソース・メンバーに関連付けられたパーティ・レコードの公開一意識別子。 -
PartyUniqueName: string
タイトル:
Name
読取り専用:true
最大長:900
キュー・リソース・メンバーに関連付けられたパーティ・レコードの一意の名前。 -
QueueId: integer (int64)
タイトル:
Queue ID
キューの一意の識別子。 -
QueueName: string
タイトル:
Queue Name
読取り専用:true
最大長:400
このリソースが関連付けられているキューの名前。 -
QueueNumber: string
タイトル:
Queue Number
読取り専用:true
最大長:30
このリソースが関連付けられているキューの公開一意識別子。 -
QueueResourceId: integer (int64)
タイトル:
Queue Resource ID
キュー・リソース・メンバーの一意の識別子。 -
UpdateFlag: boolean
タイトル:
Can Update
読取り専用:true
リソース・メンバーを更新できるかどうかを示します。 デフォルト値はtrueです。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
例:
次の例は、RESTリソースに対するGETリクエストを発行して、すべてのリソース・メンバーを取得する方法を示しています。
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
GET /crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200 Ok Date: Fri, 12 Aug 2016 10:32:50 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [3] 0: { "CreatedBy": "cyndi.hause" "CreationDate": "2016-06-22T08:23:05-07:00" "EnabledFlag": true "LastUpdateDate": "2016-06-22T08:23:29-07:00" "LastUpdateLogin": "35D14D2EF5F93941E0538F06F00ACD9C" "LastUpdatedBy": "cyndi.hause" "ObjectId": 300100096095506 "ObjectTypeCd": "ORA_SVC_RESOURCE" "QueueId": 300100090462863 "QueueResourceId": 300100131284071 "EmailAddress": "cyndi.hause@oracle.com" "PartyId": 300100096095506 "PartyName": "Cyndi Hause" "PartyNumber": "CDRM_423143" "FormattedPhoneNumber": null "PartyUniqueName": "Cyndi Hause" "links": [4] 0: { "rel": "self" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F081B8E4670000000EACED00057708000110F07F9FF512" "name": "resourceMembers" "kind": "item" "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } } 1: { "rel": "canonical" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F081B8E4670000000EACED00057708000110F07F9FF512" "name": "resourceMembers" "kind": "item" } 2: { "rel": "parent" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863" "name": "queues" "kind": "item" } 3: { "rel": "lov" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F081B8E4670000000EACED00057708000110F07F9FF512/lov/ObjectTypeCdLookup" "name": "ObjectTypeCdLookup" "kind": "collection" } - } 1: { "CreatedBy": "autouihcmadm2" "CreationDate": "2016-07-22T01:44:09-07:00" "EnabledFlag": true "LastUpdateDate": "2016-07-22T01:44:09-07:00" "LastUpdateLogin": "383596DB08B13EEBE0538F06F00AB56A" "LastUpdatedBy": "autouihcmadm2" "ObjectId": 300100089830992 "ObjectTypeCd": "ORA_SVC_RESOURCE" "QueueId": 300100090462863 "QueueResourceId": 300100155149543 "EmailAddress": "autouihcmhda1.svc@oracle.com" "PartyId": 300100089830992 "PartyName": "autouihcmhda1 svc" "PartyNumber": "CDRM_382962" "FormattedPhoneNumber": "+1 (111) 222-3333" "PartyUniqueName": "autouihcmhda1 svc" "links": [4] 0: { "rel": "self" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F083250CE70000000EACED00057708000110F07F405E50" "name": "resourceMembers" "kind": "item" "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } } 1: { "rel": "canonical" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F083250CE70000000EACED00057708000110F07F405E50" "name": "resourceMembers" "kind": "item" } 2: { "rel": "parent" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863" "name": "queues" "kind": "item" } 3: { "rel": "lov" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F083250CE70000000EACED00057708000110F07F405E50/lov/ObjectTypeCdLookup" "name": "ObjectTypeCdLookup" "kind": "collection" } - } 2: { "CreatedBy": "justin.anderson" "CreationDate": "2016-05-15T20:17:02-07:00" "EnabledFlag": true "LastUpdateDate": "2016-05-15T20:17:03-07:00" "LastUpdateLogin": "32E8060020AA0E36E0538F06F00A18A7" "LastUpdatedBy": "justin.anderson" "ObjectId": 300100090493087 "ObjectTypeCd": "ORA_SVC_RESOURCE" "QueueId": 300100090462863 "QueueResourceId": 300100090793146 "EmailAddress": "justin.anderson@oracle.com" "PartyId": 300100090493087 "PartyName": "justin anderson" "PartyNumber": "CDRM_389992" "FormattedPhoneNumber": "3033348476" "PartyUniqueName": "justin anderson" "links": [4] 0: { "rel": "self" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F07F4F0CBA0000000EACED00057708000110F07F4A789F" "name": "resourceMembers" "kind": "item" "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } } 1: { "rel": "canonical" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F07F4F0CBA0000000EACED00057708000110F07F4A789F" "name": "resourceMembers" "kind": "item" } 2: { "rel": "parent" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863" "name": "queues" "kind": "item" } 3: { "rel": "lov" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers/00020000000EACED00057708000110F07F4F0CBA0000000EACED00057708000110F07F4A789F/lov/ObjectTypeCdLookup" "name": "ObjectTypeCdLookup" "kind": "collection" } - } - "count": 3 "hasMore": false "limit": 25 "offset": 0 "links": [1] 0: { "rel": "self" "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/queues/300100090462863/child/resourceMembers" "name": "resourceMembers" "kind": "collection" } - }