機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. クライアント・アプリケーション

クライアント・アプリケーションの更新

put

/documents/api/1.2/config/clientApplications/{id}

既存のカスタム・アクション・クライアント・アプリケーションの次のフィールドのいずれかまたは両方を更新 : metadataのfileおよびisEnabled属性。

この操作を実行するには、管理者である必要があります。

リクエストはマルチパートHTTPリクエストで、1つのパートが属性isEnabledを持つJSONオブジェクト(metadata)、もう1つのパートがファイル自体のコンテンツ(file)です。

リクエスト

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

  • クライアント・アプリケーションのグローバル一意識別子(GUID)。

フォーム・パラメータ

  • アップロードするFile(json payload)。

    Content-Type: application/jsonを使用して、この情報をJSONオブジェクトとして示します。

  • このパラメータを使用して、既存のクライアント・アプリケーションのisEnabledフラグ値を更新できます。

    Content-Type: application/jsonを使用して、この情報をJSONオブジェクトとして示します。

    たとえば:

    {

    "isEnabled": "true"

    }
トップに戻る

レスポンス

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

200レスポンス

リクエストが処理されました。

本文 ()
ルート・スキーマ : ClientApplicationResponse
タイプ: object
特定のクライアント・アプリケーションに関するMetadata
ソースを表示
ネストされたスキーマ : ClientApplicationLinkDetails
タイプ: object
クライアント・アプリケーションのリンク。
ソースを表示
レスポンスの例(application/json)
{
    "createdTime":"2023-05-03T11:26:27Z",
    "errorCode":"0",
    "id":"7579B0A49C7A34960929793458C1B355",
    "isEnabled":"true",
    "modifiedTime":"2023-05-03T15:22:14Z",
    "name":"testapp01"
}

404レスポンス

アプリケーションIDが見つかりません

トップに戻る

例

次の例では、メタデータを更新 - 指定したクライアント・アプリケーションの'isEnabled'属性および'file'。

PUT .../config/clientApplications/427090D588695B4B4C59D868E83E27B9

リクエスト・ヘッダー

このリクエストは、次の一般形式の境界デリミタを指定したマルチパート・リクエストです。 
Content-Type: multipart/form-data; boundary=---1234567890

リクエスト本文

-----1234567890
Content-Disposition: form-data; name="metadata"
Content-Type: application/json
{ 
    "isEnabled":"true" 
}
-----1234567890
Content-Disposition: form-data; name="file"; filename="clientconfig.json"
Content-Type: application/json
 
<File Content>
-----1234567890--
.

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "createdTime": "2023-05-08T12:37:28Z",
  "errorCode": "0",
  "id": "427090D588695B4B4C59D868E83E27B9",
  "isEnabled": "true",
  "modifiedTime": "2023-05-09T10:16:58Z",
  "name": "testapp"
}

例2

次の例では、メタデータを更新 - 指定されたクライアント・アプリケーションの'isEnabled'属性。

PUT .../config/clientApplications/427090D588695B4B4C59D868E83E27B9

リクエスト・ヘッダー

このリクエストは、次の一般形式の境界デリミタを指定したマルチパート・リクエストです。 
Content-Type: multipart/form-data; boundary=---1234567890

リクエスト本文

-----1234567890
Content-Disposition: form-data; name="metadata"
Content-Type: application/json
{ 
    "isEnabled":"false" 
}
-----1234567890

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "createdTime": "2023-05-08T12:37:28Z",
  "errorCode": "0",
  "id": "427090D588695B4B4C59D868E83E27B9",
  "isEnabled": "false",
  "modifiedTime": "2023-05-11T07:51:57Z",
  "name": "testapp"
}

例3

次の例では、指定されたクライアント・アプリケーションのファイルを更新します。

PUT .../config/clientApplications/427090D588695B4B4C59D868E83E27B9

リクエスト・ヘッダー

このリクエストは、次の一般形式の境界デリミタを指定したマルチパート・リクエストです。 
Content-Type: multipart/form-data; boundary=---1234567890

リクエスト本文

-----1234567890
Content-Disposition: form-data; name="file"; filename="clientconfig.json"
Content-Type: application/json
 
<File Content>
-----1234567890--

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "createdTime": "2023-05-08T12:37:28Z",
  "errorCode": "0",
  "id": "427090D588695B4B4C59D868E83E27B9",
  "isEnabled": "false",
  "modifiedTime": "2023-05-11T07:51:57Z",
  "name": "testapp"
}

例4

次の例では、指定したクライアント・アプリケーションIDが存在しないため、エラーが返されます。

PUT .../config/clientApplications/123456D588695A1A1C59D868E83E27B9

リクエスト・ヘッダー

このリクエストは、次の一般形式の境界デリミタを指定したマルチパート・リクエストです。 
Content-Type: multipart/form-data; boundary=---1234567890

リクエスト本文

-----1234567890
Content-Disposition: form-data; name="metadata"
Content-Type: application/json
{ 
    "isEnabled":"true" 
}
-----1234567890
Content-Disposition: form-data; name="file"; filename="clientconfig.json"
Content-Type: application/json
 
<File Content>
-----1234567890--

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
  "errorCode": "-16",
  "errorKey": "!csAFJSONAppDoesNotExist,123456D588695A1A1C59D868E83E27B9",
  "errorMessage": "Application '123456D588695A1A1C59D868E83E27B9' of type JSON does not exist.",
  "isEnabled": "1",
  "title": "Application '123456D588695A1A1C59D868E83E27B9' of type JSON does not exist.",
  "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}
先頭に戻る