サービス・プロバイダの取得
get
/crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}
リクエスト
パス・パラメータ
- ProviderId(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 - 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のデフォルト・バージョンを選択します。
ルート・スキーマ : serviceProviders-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
サービス・プロバイダを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
サービス・プロバイダが作成された日付。 -
ImposedEstimatedStartTime: string (date-time)
タイトル:
Imposed Estimated Start Time
サービス・プロバイダのサービス状態に対して課せられた推定開始時間。 -
ImposedServiceStateCd: string
タイトル:
Imposed Service State Code
最大長:64
デフォルト値:NONE
サービスの課せられた状態を示すコード。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
PassiveBeaconURL: string
タイトル:
Passive Beacon URL
最大長:1000
パッシブ・ビーコンが使用可能なURL。 -
ProviderAPPKey: string
最大長:
400
サービス・プロバイダのアプリケーション・キー。 -
ProviderId: integer (int64)
タイトル:
Provider ID
読取り専用:true
サービス・プロバイダの一意の識別子。 -
ProviderName: string
タイトル:
Provider Name
最大長:400
サービス・プロバイダの名前。 -
services: array Services
タイトル:
Services
サービス・リソースは、サービス・プロバイダのプレビュー下にあるサービスの詳細を表示、作成、更新および削除するために使用します。
ネストされたスキーマ : サービス
タイプ:
array
タイトル:
Services
サービス・リソースは、サービス・プロバイダのプレビュー下にあるサービスの詳細を表示、作成、更新および削除するために使用します。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : serviceProviders-services-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
サービスを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
サービスが作成された日付。 -
EstimatedStartTime: string (date-time)
タイトル:
Estimated Start Time
サービス状態の次の推定開始時間。 -
LastAvailDate: string (date-time)
タイトル:
Last Available Date
サービスが最後に使用可能になった日付。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ProviderId: integer (int64)
タイトル:
Provider ID
サービス・プロバイダの一意の識別子。 -
serviceHistories: array Service Histories
タイトル:
Service Histories
サービス履歴リソースは、サービスの可用性に関する履歴情報を表示するために使用されます。 -
ServiceId: integer (int64)
タイトル:
Service ID
読取り専用:true
サービスの一意の識別子。 -
ServiceName: string
タイトル:
Service Name
最大長:400
サービスの名前。 -
ServiceStateCd: string
タイトル:
Service State Code
最大長:64
デフォルト値:UNAVAILABLE
サービスの状態を示すコード。
ネストされたスキーマ : サービス履歴
タイプ:
array
タイトル:
Service Histories
サービス履歴リソースは、サービスの可用性に関する履歴情報を表示するために使用されます。
ソースを表示
ネストされたスキーマ : serviceProviders-services-serviceHistories-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
サービス履歴を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
サービス履歴が作成された日付。 -
EstimatedStartTime: string (date-time)
タイトル:
Estimated Start Time
サービス状態の次の推定開始時間。 -
HistoryId: integer (int64)
タイトル:
History ID
読取り専用:true
サービス履歴の一意の識別子。 -
LastAvailDate: string (date-time)
タイトル:
Last Available Date
サービス履歴が最後に使用可能になった日付。 -
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
リソース・インスタンスに関連付けられたリンク関係。 -
ServiceId: integer (int64)
タイトル:
Service ID
履歴が属するサービスの一意の識別子。 -
ServiceStateCd: string
タイトル:
Service State Code
最大長:64
サービスの状態を示すコード。
リンク
- ImposedServiceStateCdLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_IMP_SERVICE_STATE_CD
サービスの課せられた状態を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ImposedServiceStateCd;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- サービス産業
-
パラメータ:
- ProviderId:
$request.path.ProviderId
サービス・リソースは、サービス・プロバイダのプレビュー下にあるサービスの詳細を表示、作成、更新および削除するために使用します。 - ProviderId:
例:
次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、サービス・プロバイダを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceProviders/300100123753001
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "ProviderId": 300100123753001, "CreationDate": "2017-11-15T10:55:15+00:00", "CreatedBy": "SALES_ADMIN", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2017-11-15T10:55:15.006+00:00", "LastUpdateLogin": "5E036AAEC4662B4AE0538E09F20A26E5", "ProviderName": "Service Provider", "PassiveBeaconURL": null, "ImposedServiceStateCd": "NONE", "ImposedEstimatedStartTime": null, "ProviderAPPKey": null, "links": [ ... ] }