サービス・プロバイダの作成
post
/crmRestApi/resources/11.13.18.05/serviceProviders
リクエスト
ヘッダー・パラメータ
- 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-
ImposedEstimatedStartTime: string (date-time)
タイトル:
Imposed Estimated Start Timeサービス・プロバイダのサービス状態に対して課せられた推定開始時間。 -
ImposedServiceStateCd: string
タイトル:
Imposed Service State Code最大長:64デフォルト値:NONEサービスの課せられた状態を示すコード。 -
PassiveBeaconURL: string
タイトル:
Passive Beacon URL最大長:1000パッシブ・ビーコンが使用可能なURL。 -
ProviderAPPKey: string
最大長:
400サービス・プロバイダのアプリケーション・キー。 -
ProviderName(required): string
タイトル:
Provider Name最大長:400サービス・プロバイダの名前。 -
services: array Services
タイトル:
Servicesサービス・リソースは、サービス・プロバイダのプレビュー下にあるサービスの詳細を表示、作成、更新および削除するために使用します。
ネストされたスキーマ : サービス
タイプ:
arrayタイトル:
Servicesサービス・リソースは、サービス・プロバイダのプレビュー下にあるサービスの詳細を表示、作成、更新および削除するために使用します。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object-
EstimatedStartTime: string (date-time)
タイトル:
Estimated Start Timeサービス状態の次の推定開始時間。 -
LastAvailDate: string (date-time)
タイトル:
Last Available Dateサービスが最後に使用可能になった日付。 -
ProviderId(required): integer (int64)
タイトル:
Provider IDサービス・プロバイダの一意の識別子。 -
serviceHistories: array Service Histories
タイトル:
Service Historiesサービス履歴リソースは、サービスの可用性に関する履歴情報を表示するために使用されます。 -
ServiceName(required): string
タイトル:
Service Name最大長:400サービスの名前。 -
ServiceStateCd: string
タイトル:
Service State Code最大長:64デフォルト値:UNAVAILABLEサービスの状態を示すコード。
ネストされたスキーマ : サービス履歴
タイプ:
arrayタイトル:
Service Historiesサービス履歴リソースは、サービスの可用性に関する履歴情報を表示するために使用されます。
ソースを表示
ネストされたスキーマ : serviceProviders-services-serviceHistories-item-post-request
タイプ:
ソースを表示
object-
EstimatedStartTime: string (date-time)
タイトル:
Estimated Start Timeサービス状態の次の推定開始時間。 -
LastAvailDate: string (date-time)
タイトル:
Last Available Dateサービス履歴が最後に使用可能になった日付。 -
ServiceId: integer (int64)
タイトル:
Service ID履歴が属するサービスの一意の識別子。 -
ServiceStateCd: string
タイトル:
Service State Code最大長:64サービスの状態を示すコード。
応答
サポートされるメディア・タイプ
- 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リソースに対して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/serviceProviders
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{
"ProviderName": "Service Provider"
}
レスポンス本文の例
次の例は、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": [
...
]
}