すべてのリソース・メンバーの取得
get
/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers
リクエスト
パス・パラメータ
- SrNumber(required): string
サービス・リクエストの識別に使用される一意の番号。 サービス・リクエスト番号は、組織の要件に最適な形式に構成できます。 たとえば、サービス・リクエストには、要件に応じて、サービスrequest0000012345、サービスrequest_000_12345、12345_00_serviceリクエストなどのフォーマットを設定できます。
問合せパラメータ
- 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 : メンバーIDを使用してサービス・リクエスト・リソースを検索します。
ファインダ変数:- MemberId; integer;ファインダ・サービスにパラメータとして渡されたメンバーID。
- SrResourceMemberResourceAltKeyFinder : 指定した一意の識別子を使用してサービス・リクエスト・チーム・メンバーを検索します。
ファインダ変数:- ResourcePartyNumber; string; サービス・リクエスト・チーム・メンバーの公開一意識別子。
- SrNumber; string; サービス・リクエストの公開一意識別子。
- PrimaryKey : メンバーIDを使用してサービス・リクエスト・リソースを検索します。
- 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; サービス・リクエスト・リソース・メンバーが作成された日時。
- LastUpdateDate; string; サービス・リクエスト・リソース・メンバー・レコードが最後に更新された日時。
- LastUpdateLogin; string; サービス・リクエスト・リソース・メンバーを最後に更新したユーザーに関連付けられたアプリケーション・ログイン。
- LastUpdatedBy; string; サービス・リクエスト・リソース・メンバー・レコードを最後に更新したユーザー。
- MemberId; integer;一意の識別子サービス・リクエスト・リソース・メンバー・レコード。
- ObjectId; integer; サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの一意の識別子。
- ObjectTypeCd; string; リソースが個人かチームかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_RES_OBJECT_TYPE_CDで定義されます。
- PartyUniqueName; string; サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの一意の名前。
- ResourceEmailAddress; string; リソース・メンバーの電子メール・アドレス。
- ResourceFormattedPhoneNumber; string; リソース・メンバーの書式設定された電話番号。
- ResourceName; string; サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの名前。
- ResourcePartyNumber; string; サービス・リクエスト・チーム・メンバーの公開一意識別子。
- SrId; integer; リソースが関連付けられているサービス・リクエストの一意の識別子。
- SrNumber; string; サービス・リクエスト番号の公開一意識別子。
- UserGUID; string; サービス・リクエスト・リソース・メンバーとして追加されたリソースのグローバル一意識別子。
- UserId; integer; サービス・リクエスト・リソース・メンバーとして追加されたリソースのユーザー識別子。
- Username; string;リソース・メンバーのユーザー名。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : serviceRequests-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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : serviceRequests-resourceMembers-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
リソースをサービス・リクエストのメンバーとして追加したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
サービス・リクエスト・リソース・メンバーが作成された日時。 -
DeleteFlag: boolean
タイトル:
Can Delete
読取り専用: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
リソース・インスタンスに関連付けられたリンク関係。 -
MemberId: integer (int64)
タイトル:
Member ID
一意の識別子サービス・リクエスト・リソース・メンバー・レコード。 -
ObjectId: integer (int64)
タイトル:
Service Request Team Member Resource ID
サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの一意の識別子。 -
ObjectTypeCd: string
タイトル:
Object Type
読取り専用:true
最大長:30
デフォルト値:ORA_SVC_RESOURCE
リソースが個人かチームかを示すコード。 受け入れられる値のリストは、参照ORA_SVC_RES_OBJECT_TYPE_CDで定義されます。 -
OwnerFlag: boolean
タイトル:
Assigned To
サービス・リクエストがリソース・メンバーに割り当てられているかどうかを示します。 はいの場合、値はTrueで、そうでない場合はFalseです。 -
PartyUniqueName: string
タイトル:
Unique Party Name
読取り専用:true
最大長:900
サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの一意の名前。 -
ResourceEmailAddress: string
タイトル:
Email
読取り専用:true
最大長:320
リソース・メンバーの電子メール・アドレス。 -
ResourceFormattedAddress: string
タイトル:
Resource Formatted Address
読取り専用:true
サービス・リクエスト・リソース・メンバーのフォーマット済住所を示します。 -
ResourceFormattedPhoneNumber: string
タイトル:
Phone
読取り専用:true
リソース・メンバーの書式設定された電話番号。 -
ResourceName: string
タイトル:
Name
最大長:360
サービス・リクエスト・リソース・メンバーとして追加された個々のリソースの名前。 -
ResourcePartyNumber: string
タイトル:
Resource Number
読取り専用:true
最大長:30
サービス・リクエスト・チーム・メンバーの公開一意識別子。 -
SrId: integer (int64)
タイトル:
Service Request ID
リソースが関連付けられているサービス・リクエストの一意の識別子。 -
SrNumber: string
タイトル:
Service Request Number
最大長:30
サービス・リクエスト番号の公開一意識別子。 -
UpdateFlag: boolean
タイトル:
Can Update
読取り専用:true
リソース・メンバーが更新されたかどうかを示します。 -
UserGUID: string
タイトル:
User GUID
読取り専用:true
最大長:64
サービス・リクエスト・リソース・メンバーとして追加されたリソースのグローバル一意識別子。 -
UserId: integer (int64)
タイトル:
User ID
読取り専用:true
サービス・リクエスト・リソース・メンバーとして追加されたリソースのユーザー識別子。 -
Username: string
タイトル:
User Name
読取り専用:true
最大長:100
リソース・メンバーのユーザー名。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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/serviceRequests/SR0000066002/child/resourceMembers
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200 OK Date: Wed, 20 Sep 2016 11:40:50 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "items": [ { "MemberId": 300100092156953, "SrId": 300100092156941, "ObjectTypeCd": "ORA_SVC_RESOURCE", "ObjectId": 100010032635399, "CreatedBy": "autouicsm1", "CreationDate": "2016-09-08T03:57:28-07:00", "LastUpdatedBy": "autouicsm1", "LastUpdateDate": "2016-09-08T03:58:25-07:00", "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832", "ResourceName": "Dan Foreman", "PartyUniqueName": "Dan Foreman", "ResourceEmailAddress": "sendmail-test-discard@oracle.com", "ResourceFormattedPhoneNumber": "+1 (415) 820-3815", "UserGUID": "331DF0E7846E4318E2B2399766991627", "UserId": 100010032635372, "Username": "SALES_REPRESENTATIVE", "OwnerFlag": true, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953", "name": "resourceMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953", "name": "resourceMembers", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002", "name": "serviceRequests", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953/lov/ResourcePickerPVO", "name": "ResourcePickerPVO", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156953/lov/ObjectTypeLookup", "name": "ObjectTypeLookup", "kind": "collection" } ] }, { "MemberId": 300100092156951, "SrId": 300100092156941, "ObjectTypeCd": "ORA_SVC_RESOURCE", "ObjectId": 300100075337077, "CreatedBy": "autouicsm1", "CreationDate": "2016-09-08T03:56:49-07:00", "LastUpdatedBy": "autouicsm1", "LastUpdateDate": "2016-09-08T03:58:25-07:00", "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832", "ResourceName": "autouicsm1 svc", "PartyUniqueName": "autouicsm1 svc", "ResourceEmailAddress": "autouicsm1@oracle.com", "ResourceFormattedPhoneNumber": null, "UserGUID": "88CC09DCC20A93F7BB0F1C3D400D45E5", "UserId": 100100048620337, "Username": "autouicsm1", "OwnerFlag": false, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951", "name": "resourceMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951", "name": "resourceMembers", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002", "name": "serviceRequests", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951/lov/ResourcePickerPVO", "name": "ResourcePickerPVO", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156951/lov/ObjectTypeLookup", "name": "ObjectTypeLookup", "kind": "collection" } ] }, { "MemberId": 300100092156952, "SrId": 300100092156941, "ObjectTypeCd": "ORA_SVC_RESOURCE", "ObjectId": 300100075388631, "CreatedBy": "autouicsm1", "CreationDate": "2016-09-08T03:56:49-07:00", "LastUpdatedBy": "autouicsm1", "LastUpdateDate": "2016-09-08T03:58:25-07:00", "LastUpdateLogin": "3BFDA714014A0F85E053780CF10A6832", "ResourceName": "autouislr1 svc", "PartyUniqueName": "autouislr1 svc", "ResourceEmailAddress": "autouislr1@oracle.com", "ResourceFormattedPhoneNumber": null, "UserGUID": "AF0BB547DED57A329ABC84A07F6CB1BF", "UserId": 100100048620373, "Username": "autouislr1", "OwnerFlag": false, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952", "name": "resourceMembers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952", "name": "resourceMembers", "kind": "item" }, { "rel": "parent", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002", "name": "serviceRequests", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952/lov/ResourcePickerPVO", "name": "ResourcePickerPVO", "kind": "collection" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100092156952/lov/ObjectTypeLookup", "name": "ObjectTypeLookup", "kind": "collection" } ] } ], "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers", "name": "resourceMembers", "kind": "collection" } ] }