Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

サービスの更新

patch

/crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}

リクエスト

パス・パラメータ

ProviderId(required): integer(int64)

サービス・プロバイダの一意の識別子。
ServiceId(required): integer(int64)

サービスの一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: 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

サービスの状態を示すコード。

{
    "required":[
        "ProviderId",
        "ServiceName"
    ],
    "type":"object",
    "properties":{
        "ProviderId":{
            "title":"Provider ID",
            "type":"integer",
            "description":"The unique identifier of the service provider.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service was last available.",
            "format":"date-time",
            "nullable":true
        },
        "ServiceStateCd":{
            "title":"Service State Code",
            "maxLength":64,
            "type":"string",
            "description":"The code indicating the state of the service.",
            "nullable":true,
            "default":"UNAVAILABLE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ServiceName":{
            "title":"Service Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service.",
            "nullable":false
        },
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true
        },
        "serviceHistories":{
            "title":"Service Histories",
            "type":"array",
            "description":"The service histories resource is used to view the historical information about the availability of a service.",
            "items":{
                "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-patch-request"
            }
        }
    }
}

ネストされたスキーマ : サービス履歴

タイプ: array

タイトル: Service Histories

サービス履歴リソースは、サービスの可用性に関する履歴情報を表示するために使用されます。

ソースを表示

Array of: object serviceProviders-services-serviceHistories-item-patch-request

{
    "title":"Service Histories",
    "type":"array",
    "description":"The service histories resource is used to view the historical information about the availability of a service.",
    "items":{
        "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-patch-request"
    }
}

ネストされたスキーマ : serviceProviders-services-serviceHistories-item-patch-request

タイプ: object

ソースを表示

EstimatedStartTime: string (date-time)

タイトル: Estimated Start Time

サービス状態の次の推定開始時間。
LastAvailDate: string (date-time)

タイトル: Last Available Date

サービス履歴が最後に使用可能になった日付。

{
    "type":"object",
    "properties":{
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service history was last available.",
            "format":"date-time",
            "nullable":true
        },
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : 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

サービスの状態を示すコード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProviderId":{
            "title":"Provider ID",
            "type":"integer",
            "description":"The unique identifier of the service provider.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the service was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceStateCd":{
            "title":"Service State Code",
            "maxLength":64,
            "type":"string",
            "description":"The code indicating the state of the service.",
            "nullable":true,
            "default":"UNAVAILABLE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceId":{
            "title":"Service ID",
            "type":"integer",
            "description":"The unique identifier of the service.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "serviceHistories":{
            "title":"Service Histories",
            "type":"array",
            "description":"The service histories resource is used to view the historical information about the availability of a service.",
            "items":{
                "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-response"
            }
        },
        "ServiceName":{
            "title":"Service Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service.",
            "nullable":false,
            "x-queryable":true
        },
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service was last available.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the service was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : サービス履歴

タイプ: array

タイトル: Service Histories

サービス履歴リソースは、サービスの可用性に関する履歴情報を表示するために使用されます。

ソースを表示

Array of: object serviceProviders-services-serviceHistories-item-response

{
    "title":"Service Histories",
    "type":"array",
    "description":"The service histories resource is used to view the historical information about the availability of a service.",
    "items":{
        "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : 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

サービスの状態を示すコード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the service history was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryId":{
            "title":"History ID",
            "type":"integer",
            "description":"The unique identifier of the service history.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service history was last available.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ServiceStateCd":{
            "title":"Service State Code",
            "maxLength":64,
            "type":"string",
            "description":"The code indicating the state of the service.",
            "nullable":false,
            "x-queryable":true
        },
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the service history was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the service history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceId":{
            "title":"Service ID",
            "type":"integer",
            "description":"The unique identifier of the service to which the history belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

リンク

ServiceStateCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_SERVICE_STATE_CD

サービスの状態を示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ServiceStateCd;ターゲット属性: LookupCode
表示属性: 意味

serviceHistories

操作: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}/child/serviceHistories

パラメータ:

ProviderId: $request.path.ProviderId
ServiceId: $request.path.ServiceId

(serviceHistoriesのリソース)

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行してサービスを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceProviders/child/services/300100123781596

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"ServiceStateCd" : "UNAVAILABLE"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-11-20T11:38:38+00:00",
"LastUpdateDate": "2017-11-20T11:42:47+00:00",
"LastUpdateLogin": "5E67CBDF62AB11EEE0538E09F20A463C",
"LastUpdatedBy": "SALES_ADMIN",
"ProviderId": 300100123753001,
"ServiceId": 300100123781596,
"EstimatedStartTime": null,
"LastAvailDate": "2017-11-20T11:38:38.011+00:00",
"ServiceName": "test service",
"ServiceStateCd": "UNAVAILABLE",
"links": [
 ...
 ]
}

「トップに戻る」