機械翻訳について
  1. Content Management REST API
  2. タスク
  3. チャネル

すべてのチャネルをリスト

get

/content/management/api/v1.1/channels

すべてのチャネルをリストします。

リクエスト

問合せパラメータ
  • このパラメータは、リスト内の各チャネルで返されるフィールドを制御するために使用します。 このパラメータは、フィールド名または「すべて」のカンマ区切りリストを受け入れます。 これらのフィールドは、リスト内のチャネルごとに返されます。 すべてのフィールド名は大/小文字が区別され、ユーザーは問合せで正しいフィールド名を指定する必要があります。 各チャネルには、標準フィールド(id、name、description、createdBy、createdDate、updatedBy、updatedDate、isSiteChannel)と追加フィールド(channelType、publishPolicy、localizationPolicy、channelTokens)の両方があります。 fieldsを「すべて」 (大/小文字を区別しない)として指定すると、すべての標準フィールドおよび追加フィールドが返されます。 標準フィールドは常にレスポンスで返され、除外することはできません。 ユーザーは追加のフィールドのみをフィルタ処理できます。 このパラメータは問合せではオプションであり、結果にはレスポンスの標準フィールドのみが表示されます。 問合せで指定されたフィールド名が正しくないか無効な場合は、エラーがスローされます。

    例: ?fields=channelTokens,localizationPolicy
    これにより、すべての標準フィールドが、チャネルごとにchannelTokensとlocalizationPolicyの追加フィールドとともに返されます。
    例: ?fields=all
    これにより、すべての標準フィールドと、各チャネルに追加するすべてのフィールドが返されます。
  • このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。
    デフォルト値: 100
  • このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。
    デフォルト値: 0
  • このパラメータは、結果の順序を制御するために使用します。 この問合せパラメータの値はfieldName:[asc/desc]の形式に従います。「昇順」は、昇順を表します「説明」は降順を表し、デフォルトの順序は「昇順」です。 使用できるフィールド名は、nameとupdatedDateのみです。
    デフォルト値: name:asc
  • このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 現在で使用できるfieldNamesは、roleName、repositoryIdおよびnameのみで、許可されている演算子は、nameおよびeq上のmtのみです。 この問合せパラメータはオプションで、少なくとも指定されたロールを持つリソースをフィルタ処理するroleName eq "viewer"にデフォルト設定されます。
    例:
    ?q=(roleName eq "manager")
    デフォルト値: roleName eq "viewer"
  • このパラメータは、返されたチャネルを指定したロール名でフィルタするために使用されます。 このパラメータは問合せではオプションであり、デフォルトですべてのチャネルが返されます。
    許容値: [ "viewer", "contributor", "manager" ]
  • このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。
    デフォルト値: false
トップに戻る

レスポンス

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

200レスポンス

OK。
本文()
ルート・スキーマ : チャネル
型: object
チャネル
ソースを表示
ネストされたスキーマ : aggregationResults
型: array
集計結果。
ソースを表示
ネストされたスキーマ: items
型: array
コレクションに含まれる特異なリソース。
ソースを表示
ネストされたスキーマ : 殺害
型: array
固定品目。 検索リストの上部に固定されたアイテムを表示
ソースを表示
ネストされたスキーマ : AggregationResult
型: object
ソースを表示
ネストされたスキーマ : チャネル
型: object
チャネル
ソースを表示
ネストされたスキーマ : channelAccessControls
型: array
チャネル・アクセス制御のリスト。セキュアな標準チャネルでのみ許可されます。 現在、セキュア・チャネルに対してのみアクセス制御を許可しています
ソースを表示
ネストされたスキーマ : channelTokens
型: array
チャネルのトークンのリスト。
ソースを表示
ネストされたスキーマ : date
型: object
date
ソースを表示
ネストされたスキーマ : rankingPolicyContentTypes
型: array
チャネルの検索ランキング・ポリシー範囲。
ソースを表示
ネストされたスキーマ: repositories
型: array
チャネルに関連付けられたリポジトリ。 現在、サイト・チャネルのデフォルト・リポジトリのみが公開されています。
ソースを表示
ネストされたスキーマ : channelAccessControls
型: object
channelAccessControls
ソースを表示
  • 許容値: [ "CLOUD_USERS", "SERVICE_USERS", "SPECIFIC_USERS" ]
    付与されるアクセス制御タイプ、指定可能な値はCLOUD_USERS、SERVICE_USERS、SPECIFIC_USERS、デフォルトはCLOUD_USERSです
  • users
    チャネル・アクセス制御が提供される特定のユーザーで、アクセス制御タイプがSPECIFC_USERSの場合にのみ許可されます
ネストされたスキーマ: users
型: array
チャネル・アクセス制御が提供される特定のユーザーで、アクセス制御タイプがSPECIFC_USERSの場合にのみ許可されます
ソースを表示
ネストされたスキーマ : UserId
型: object
UserId
ソースを表示
ネストされたスキーマ : channelToken
型: object
channelToken
ソースを表示
ネストされたスキーマ : RepositoryId
型: object
RepositoryId
ソースを表示

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー
トップに戻る

例

次の例は、cURLを使用してRESTリソースにGETリクエストを送信することによってすべてのチャネルを取得する方法を示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/channels'

例1:

このとき、レスポンスにtotalResults値を含むすべてのチャネルがリストされます。

/content/management/api/v1.1/channels?totalResults=true

レスポンス本文

{
    "hasMore": false,
    "offset": 0,
    "count": 2,
    "limit": 2,
    "totalResults": 2,
    "items": [
    {
      "id": "CCB59F44D5015819EBC0F86A2B3133B22638AF433F1E",
      "name": "channel1",
      "description": "channel description1 updated",
      "createdBy": "marketing.user",
      "createdDate": {
        "value": "2018-12-10T07:00:42.862Z",
        "timezone": "UTC"
    },
      "updatedBy": "marketing.user",
      "updatedDate": {
        "value": "2018-12-10T09:41:56.783Z",
        "timezone": "UTC"
    },
      "isSiteChannel": false,
      "links": [
        {
      "href": "https://host:port/content/management/api/v1.1/channels/CCB59F44D5015819EBC0F86A2B3133B22638AF433F1E",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
      }
      ]
    },
    {
      "id": "CC03EC1531E0E39F6D6BA75CEE430DDBEA79EDD5F5B0",
      "name": "channel2",
      "description": "",
      "createdBy": "marketing.user",
      "createdDate": {
        "value": "2018-12-10T07:50:34.832Z",
        "timezone": "UTC"
    },
      "updatedBy": "marketing.user",
      "updatedDate": {
        "value": "2018-12-10T07:50:34.832Z",
        "timezone": "UTC"
    },
      "isSiteChannel": false,
      "links": [
        {
      "href": "https://host:port/content/management/api/v1.1/channels/CC03EC1531E0E39F6D6BA75CEE430DDBEA79EDD5F5B0",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
      }
      ]
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/channels?totalResults=true",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels?totalResults=true",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/metadata-catalog/channels",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels?offset=0&totalResults=true",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels?offset=0&totalResults=true",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }

例2:

このリストには、索引3から開始して関連するlocalizationPolicyリストを持つ最初の3つの使用可能なチャネルには、totalResults値、rolenameはmanagerで、レスポンスのフィールド名の降順でリストされます。

/content/management/api/v1.1/channels?limit=3&offset=3&totalResults=true&orderBy=name:desc&fields=localizationPolicy&roleName=manager

レスポンス本文

{
    "hasMore": false,
    "offset": 3,
    "count": 2,
    "limit": 5,
    "totalResults": 5,
    "items": [
    {
      "id": "CC03EC1531E0E39F6D6BA75CEE430DDBEA79EDD5F5B0",
      "name": "channel2",
      "description": "",
      "createdBy": "marketing.user",
      "createdDate": {
        "value": "2018-12-10T07:50:34.832Z",
        "timezone": "UTC"
    },
      "updatedBy": "marketing.user",
      "updatedDate": {
        "value": "2018-12-10T07:50:34.832Z",
        "timezone": "UTC"
    },
      "isSiteChannel": false,
      "localizationPolicy": "",
      "links": [
        {
      "href": "https://host:port/content/management/api/v1.1/channels/CC03EC1531E0E39F6D6BA75CEE430DDBEA79EDD5F5B0",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
      }
      ]
    },
    {
      "id": "CCB59F44D5015819EBC0F86A2B3133B22638AF433F1E",
      "name": "channel1",
      "description": "channel description1 updated",
      "createdBy": "marketing.user",
      "createdDate": {
        "value": "2018-12-10T07:00:42.862Z",
        "timezone": "UTC"
    },
      "updatedBy": "marketing.user",
      "updatedDate": {
        "value": "2018-12-10T09:41:56.783Z",
        "timezone": "UTC"
    },
      "isSiteChannel": false,
      "localizationPolicy": "",
      "links": [
        {
      "href": "https://host:port/content/management/api/v1.1/channels/CCB59F44D5015819EBC0F86A2B3133B22638AF433F1E",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
      }
      ]
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/channels?totalResults=true&offset=3&limit=3&roleName=manager&orderBy=name:desc&fields=localizationPolicy",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels?totalResults=true&offset=3&limit=3&roleName=manager&orderBy=name:desc&fields=localizationPolicy",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/metadata-catalog/channels",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels?totalResults=true&offset=1&limit=3&roleName=manager&orderBy=name:desc&fields=localizationPolicy",
      "rel": "prev",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels?totalResults=true&offset=0&limit=3&roleName=manager&orderBy=name:desc&fields=localizationPolicy",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels?totalResults=true&offset=3&limit=3&roleName=manager&orderBy=name:desc&fields=localizationPolicy",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }
    }
先頭に戻る