ドキュメント用REST API

機械翻訳について

クライアント・アプリケーションの作成

post

/documents/api/1.2/config/clientApplications

新しいカスタム処理クライアント・アプリケーションを作成します。 1つ以上のカスタム・アクション定義を含むJSON形式の単一構成ファイルが必要です。

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

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

リクエスト

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

multipart/form-data

フォーム・パラメータ

file: file

アップロードするFile(JSON payload)。
Content-Type: application/jsonを使用して、この情報をJSONオブジェクトとして示します。
metadata: string

このパラメータを使用して、新しいクライアント・アプリケーションの入力パラメータnameおよびisEnabledを渡すことができます。
Content-Type: application/jsonを使用して、この情報をJSONオブジェクトとして示します。
TheフィールドisEnabledはオプションです。 このフィールドのデフォルト値はtrueです
たとえば:
{
"name": "testApp",
"isEnabled": "false"
}

トップに戻る

レスポンス

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

application/json
application/xml

201レスポンス

作成されました。リクエストが処理され、新規のリソースが作成されました。

ヘッダー

Location: string

新規作成されたリソースのURIは、Locationヘッダーフィールドにあります。

ルート・スキーマ : PostClientApplicationResponse

タイプ: object

特定のクライアント・アプリケーションに関するMetadata

ソースを表示

createdTime(optional): string

クライアント・アプリケーションが作成された日付。
errorCode(optional): string

エラー・コードがゼロ(0)の場合は、エラーなしです
id(optional): string

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

クライアント・アプリケーションが有効/無効かどうかを示すフラグ。
modifiedTime(optional): string

クライアント・アプリケーションが最後に変更された日付。
name(optional): string

クライアント・アプリケーション名。

{
    "description":"Metadata about a specific client application",
    "properties":{
        "createdTime":{
            "type":"string",
            "description":"Date the client application was created."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of the client application."
        },
        "isEnabled":{
            "type":"string",
            "description":"Flag to indicate if the client application is enabled/disabled."
        },
        "name":{
            "type":"string",
            "description":"Client application name."
        },
        "modifiedTime":{
            "type":"string",
            "description":"Date the client application was last modified."
        }
    }
}

レスポンスの例(application/json)

{
    "createdTime":"2023-05-03T11:26:27Z",
    "errorCode":"0",
    "id":"7579B0A49C7A34960929793458C1B355",
    "isEnabled":"false",
    "modifiedTime":"2023-05-03T15:22:14Z",
    "name":"testapp"
}

409レスポンス

指定された名前のクライアント・アプリケーションはすでに存在します。

トップに戻る

例

次の例では、メタデータおよびカスタム・アクションjsonファイルを含む新しいクライアント・アプリケーションを作成します。 jsonファイルは、OCE webクライアントによって使用される構成ファイルです。

POST .../config/clientApplications/

リクエスト・ヘッダー

このリクエストは、次の一般形式の境界デリミタを指定したマルチパート・リクエストです。

Content-Type: multipart/form-data; boundary=---1234567890

リクエスト本文

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

HTTPステータス・コード

HTTP_STATUS = 201

JSONレスポンス

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

例2

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

POST .../config/clientApplications/

リクエスト・ヘッダー

このリクエストは、次の一般形式の境界デリミタを指定したマルチパート・リクエストです。

Content-Type: multipart/form-data; boundary=---1234567890

リクエスト本文

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

HTTPステータス・コード

HTTP_STATUS = 409

JSONレスポンス

{
  "errorCode": "-17",
  "errorKey": "!csAFUnableToPerformActionForApp,create,testapp!csAFAppAlreadyExist,testapp",
  "errorMessage": "Unable to perform 'create' action for JSON application 'testapp'. Application 'testapp' already exist.",
  "isEnabled": "0",
  "name": "testapp",
  "title": "Unable to perform 'create' action for JSON application 'testapp'. Application 'testapp' already exist.",
  "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る