機械翻訳について

移動先

• リクエスト
• レスポンス
• 例

クライアント・アプリケーションの取得

get

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

特定のカスタム・アクション・クライアント・アプリケーションのメタデータを取得します。

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

リクエスト

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

• application/json
• application/xml

パス・パラメータ

• id: string

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

問合せパラメータ

• links(optional): string

  指定したクライアント・アプリケーションのリンクをレスポンスで返すかどうかを指定します。 値links=trueは、指定されたクライアント・アプリケーションで使用可能なすべてのリンクを返します。 その他の値、またはlinksを送信しない場合、リンクは返されません。

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ : ClientApplicationResponse

タイプ: object

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

ソースを表示

• createdTime(optional): string
  クライアント・アプリケーションが作成された日付。
• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• id(optional): string
  クライアント・アプリケーションのグローバル一意識別子(GUID)。
• isEnabled(optional): string
  クライアント・アプリケーションが有効/無効かどうかを示すフラグ。
• links(optional): array links
  クライアント・アプリケーションのリンク。
• 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."
        },
        "links":{
            "type":"array",
            "description":"Links for the client application.",
            "items":{
                "$ref":"#/definitions/ClientApplicationLinkDetails"
            }
        }
    }
}

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

タイプ: array

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

ソースを表示

• Array of: object ClientApplicationLinkDetails
  クライアント・アプリケーションのリンク。

{
    "type":"array",
    "description":"Links for the client application.",
    "items":{
        "$ref":"#/definitions/ClientApplicationLinkDetails"
    }
}

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

タイプ: object

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

ソースを表示

• href(optional): string
  リンク・タイプに対応するURL。
• rel(optional): string
  リンクのタイプ。これはselfおよびcanonicalです

{
    "description":"Links for the client application.",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The type of link, this will be <code>self</code> and <code>canonical</code>"
        },
        "href":{
            "type":"string",
            "description":"The URL corresponding to the link type."
        }
    }
}

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

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

404レスポンス

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

トップに戻る

例

次の例では、指定されたクライアント・アプリケーションのメタデータをリンクとともに取得します。

GET .../config/clientApplications/427090D588695B4B4C59D868E83E27B9?links=true

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "createdTime": "2023-05-08T12:37:28Z",
  "errorCode": "0",
  "id": "427090D588695B4B4C59D868E83E27B9",
  "isEnabled": "false",
  "links": [
    {
      "rel": "self",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9?links=true"
    },
    {
      "rel": "canonical",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9?links=true"
    }
  ],
  "modifiedTime": "2023-05-11T07:51:57Z",
  "name": "testapp22"
}

例2

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

GET .../config/clientApplications/123456D588695A1A1C59D868E83E27B9

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 404

JSONレスポンス

{
  "errorCode": "-16",
  "errorKey": "!csAFAppDoesNotExist,123456D588695A1A1C59D868E83E27B9",
  "errorMessage": "Application '123456D588695A1A1C59D868E83E27B9' does not exist.",
  "title": "Application '123456D588695A1A1C59D868E83E27B9' does not exist.",
  "type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

先頭に戻る