機械翻訳について

移動先

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

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

get

/documents/api/1.2/config/clientApplications

使用可能なすべてのカスタム・アクション・クライアント・アプリケーションのメタデータを取得します。

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

リクエスト

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

• application/json
• application/xml

問合せパラメータ

• links(optional): string

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

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

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

本文 ()

ルート・スキーマ : GetClientApplicationsResponse

タイプ: object

既存のクライアント・アプリケーションのMetadata

ソースを表示

• count(optional): string
  返されたクライアント・アプリケーションの数。
• errorCode(optional): string
  エラー・コードがゼロ(0)の場合は、エラーなしです
• hasMore(optional): string
  すべてのクライアント・アプリケーションが返されたかどうかを示します。 すべてのクライアント・アプリケーションが返された場合、これはゼロ(0)です。 それ以外の場合は、使用可能なレコードがさらに存在することを示す1になります。
• items(optional): array items
  クライアント・アプリケーションのリスト。
• limit(optional): string
  返されるクライアント・アプリケーションの最大数。
• links(optional): array links
  クライアント・アプリケーションのリンク。
• offset(オプション): string
  全セットの中で、アイテムのリストまたは結果のページを始める位置。
• totalResults(optional): string
  返される集計クライアント・アプリケーションの合計数。

{
    "description":"Metadata of the existing client applications",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of client applications returned."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "hasMore":{
            "type":"string",
            "description":"Indicates if all the client applications were returned. This is zero (0), if all the client applications were returned. Otherwise, it will be one (1), indicating that there are more records available."
        },
        "items":{
            "type":"array",
            "description":"List of client applications.",
            "items":{
                "$ref":"#/definitions/ClientApplicationResponse"
            }
        },
        "limit":{
            "type":"string",
            "description":"Maximum number of client applications which could be returned."
        },
        "links":{
            "type":"array",
            "description":"Links for the client applications.",
            "items":{
                "$ref":"#/definitions/ClientApplicationsLinkDetails"
            }
        },
        "offset":{
            "type":"string",
            "description":"The point at which to begin the list of items or page of results from the complete set."
        },
        "totalResults":{
            "type":"string",
            "description":"Total number of aggregated client applications returned."
        }
    }
}

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

タイプ: array

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

ソースを表示

• Array of: object ClientApplicationResponse
  特定のクライアント・アプリケーションに関するMetadata

{
    "type":"array",
    "description":"List of client applications.",
    "items":{
        "$ref":"#/definitions/ClientApplicationResponse"
    }
}

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

タイプ: array

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

ソースを表示

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

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

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

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

タイプ: object

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

ソースを表示

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

{
    "description":"Links for the client applications.",
    "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)

{
    "count":"3",
    "errorCode":"0",
    "hasMore":"0",
    "items":[
        {
            "id":"FB07627B44FA7618F0B7260B09C370AD",
            "name":"testapp1",
            "isEnabled":"true",
            "createdTime":"2023-05-04T09:39:18Z",
            "modifiedTime":"2023-05-04T09:39:18Z"
        },
        {
            "id":"066EEB53393BAA5560ED3F0C99CF4A15",
            "name":"testapp2",
            "isEnabled":"false",
            "createdTime":"2023-05-04T09:39:31Z",
            "modifiedTime":"2023-05-04T09:39:31Z"
        },
        {
            "id":"28DEF2D4E07C5D45268EFD3A4175A36C",
            "name":"testapp3",
            "isEnabled":"true",
            "createdTime":"2023-05-04T09:39:45Z",
            "modifiedTime":"2023-05-04T09:39:45Z"
        }
    ],
    "limit":"100",
    "offset":"0",
    "totalResults":"3"
}

トップに戻る

例

次の例では、既存のすべてのクライアント・アプリケーションのメタデータをリンクとともに取得します。

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

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "count": "8",
  "errorCode": "0",
  "hasMore": "0",
  "items": [
    {
      "id": "AB3BCBA038DDE4940F0F33F9AE5FE4F0",
      "name": "testapp",
      "isEnabled": "false",
      "createdTime": "2023-05-09T09:32:19Z",
      "modifiedTime": "2023-05-11T07:37:21Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/AB3BCBA038DDE4940F0F33F9AE5FE4F0"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/AB3BCBA038DDE4940F0F33F9AE5FE4F0"
        }
      ]
    },
    {
      "id": "066EEB53393BAA5560ED3F0C99CF4A15",
      "name": "testapp2",
      "isEnabled": "true",
      "createdTime": "2023-05-04T09:39:31Z",
      "modifiedTime": "2023-05-08T09:26:58Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/066EEB53393BAA5560ED3F0C99CF4A15"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/066EEB53393BAA5560ED3F0C99CF4A15"
        }
      ]
    },
    {
      "id": "A9761E8C04F56AE1476602B90A47763E",
      "name": "testapp20",
      "isEnabled": "false",
      "createdTime": "2023-05-05T13:47:28Z",
      "modifiedTime": "2023-05-05T13:47:28Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/A9761E8C04F56AE1476602B90A47763E"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/A9761E8C04F56AE1476602B90A47763E"
        }
      ]
    },
    {
      "id": "427090D588695B4B4C59D868E83E27B9",
      "name": "testapp22",
      "isEnabled": "false",
      "createdTime": "2023-05-08T12:37:28Z",
      "modifiedTime": "2023-05-11T07:51:57Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/427090D588695B4B4C59D868E83E27B9"
        }
      ]
    },
    {
      "id": "BD6BF959C9D1701E96BA2A4F9B7A31CA",
      "name": "testapp23",
      "isEnabled": "true",
      "createdTime": "2023-05-09T08:22:11Z",
      "modifiedTime": "2023-05-09T08:22:37Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/BD6BF959C9D1701E96BA2A4F9B7A31CA"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/BD6BF959C9D1701E96BA2A4F9B7A31CA"
        }
      ]
    },
    {
      "id": "28DEF2D4E07C5D45268EFD3A4175A36C",
      "name": "testapp3",
      "isEnabled": "true",
      "createdTime": "2023-05-04T09:39:45Z",
      "modifiedTime": "2023-05-04T09:39:45Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/28DEF2D4E07C5D45268EFD3A4175A36C"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/28DEF2D4E07C5D45268EFD3A4175A36C"
        }
      ]
    },
    {
      "id": "869AD367D6DE688234DB09985DEDC7BC",
      "name": "testapp33",
      "isEnabled": "true",
      "createdTime": "2023-05-09T12:18:11Z",
      "modifiedTime": "2023-05-09T12:18:54Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/869AD367D6DE688234DB09985DEDC7BC"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/869AD367D6DE688234DB09985DEDC7BC"
        }
      ]
    },
    {
      "id": "563AEEE7A14D14A12717D4B009B1C98C",
      "name": "testapp34",
      "isEnabled": "false",
      "createdTime": "2023-05-09T12:25:27Z",
      "modifiedTime": "2023-05-09T12:25:27Z",
      "links": [
        {
          "rel": "self",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/563AEEE7A14D14A12717D4B009B1C98C"
        },
        {
          "rel": "canonical",
          "href": "[OCEHost]/documents/api/1.2/config/clientApplications/563AEEE7A14D14A12717D4B009B1C98C"
        }
      ]
    }
  ],
  "limit": "100",
  "links": [
    {
      "rel": "self",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications?links=true"
    },
    {
      "rel": "canonical",
      "href": "[OCEHost]/documents/api/1.2/config/clientApplications?links=true"
    }
  ],
  "offset": "0",
  "totalResults": "8"
}

先頭に戻る