機械翻訳について
  1. Content Management REST API
  2. タスク
  3. コレクション

リポジトリのすべてのコレクションをリスト

get

/content/management/api/v1.1/repositories/{id}/collections

リポジトリ内のすべてのコレクションをリストします。

リクエスト

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

    例: ?fields=channels
    これにより、すべての標準フィールドが、各コレクションのchannels追加フィールドとともに返されます。
    例: ?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
    許容値: [ "viewer", "contributor", "manager" ]
  • このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。
    デフォルト値: false
トップに戻る

レスポンス

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

200レスポンス

OK。
本文()
ルート・スキーマ : コレクション
型: object
コレクション
ソースを表示
ネストされたスキーマ : aggregationResults
型: array
集計結果。
ソースを表示
ネストされたスキーマ: items
型: array
コレクションに含まれる特異なリソース。
ソースを表示
ネストされたスキーマ : 殺害
型: array
固定品目。 検索リストの上部に固定されたアイテムを表示
ソースを表示
ネストされたスキーマ : AggregationResult
型: object
ソースを表示
ネストされたスキーマ: Collection
型: object
コレクション
ソースを表示
ネストされたスキーマ : channels
型: array
コレクションに関連付けられているチャネル。
ソースを表示
ネストされたスキーマ : date
型: object
date
ソースを表示
ネストされたスキーマ : RepositoryIdentifier
型: object
RepositoryIdentifier
ソースを表示
ネストされたスキーマ : ruleGroups
型: array
ソースを表示
ネストされたスキーマ : ChannelInCollections
型: object
ChannelInCollections
ソースを表示
ネストされたスキーマ : RuleGroup
型: object
ルール・グループ定義
ソースを表示
  • ルール・グループに関連付けられたアセット・タイプ。ルール・グループ内のすべてのルールは、このアセット・タイプに関連するプロパティに基づきます
    例: File
  • このルール・グループを前のグループと結合するときに使用する演算子
    例: OR
  • ruleSet
    ルール・グループに関連付けられたルールのセット
ネストされたスキーマ : ruleSet
型: array
ルール・グループに関連付けられたルールのセット
ソースを表示
ネストされたスキーマ : RuleSet
型: object
ルールまたは条件のセット
ソースを表示
ネストされたスキーマ: Rule
型: object
ソースを表示
ネストされたスキーマ : ruleSet
型: array
指定されたルール・セットに関連付けられた子またはサブ・ルール・セット
ソースを表示

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

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

例

次の例は、cURLを使用してRESTリソースでGETリクエストを送信することによって、公開されたデジタル・アセットのネイティブ・ファイルを示しています:

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/repositories/{id}/collections'

例1:

このリストには、Idのリポジトリに存在するすべてのコレクションが表示されます: F264EF72737B35991E381047D5B43D87656640771B3C、フィールド名で降順に並べ替えます。 

/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?orderBy=name:desc

レスポンス本文 

{
    "hasMore": false,
    "offset": 0,
    "count": 2,
    "limit": 2,
    "items": [{
    "id": "OB19FE8746BD86E83DA44EF1FA5ED83E361FEC1D24C4",
    "name": "collection2",
    "description": "",
    "createdBy": "marketing.user",
    "createdDate": {
      "value": "2018-12-13T10:01:17.054Z",
      "timezone": "UTC"
    },
    "updatedBy": "marketing.user",
    "updatedDate": {
      "value": "2018-12-13T10:01:17.054Z",
      "timezone": "UTC"
    },
    "links": [{
      "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/OB19FE8746BD86E83DA44EF1FA5ED83E361FEC1D24C4",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }, {
    "id": "O6912875370B2BE96EEA1AC678D08D4359DF5BC30363",
    "name": "collection1",
    "description": "",
    "createdBy": "marketing.user",
    "createdDate": {
      "value": "2018-12-10T06:58:55.935Z",
      "timezone": "UTC"
    },
    "updatedBy": "marketing.user",
    "updatedDate": {
      "value": "2018-12-10T06:58:55.935Z",
      "timezone": "UTC"
    },
    "links": [{
      "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/O6912875370B2BE96EEA1AC678D08D4359DF5BC30363",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }
    ],
    "links": [{
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?orderBy=name:desc",
    "rel": "self",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?orderBy=name:desc",
    "rel": "canonical",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/metadata-catalog/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections",
    "rel": "describedby",
    "method": "GET",
    "mediaType": "application/schema+json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?offset=0&orderBy=name:desc",
    "rel": "first",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?offset=0&orderBy=name:desc",
    "rel": "last",
    "method": "GET",
    "mediaType": "application/json"
    }
    ]
    }

例2:

最初の2コレクション、1からの開始インデックス、マネージャとしてのロールがidを持つリポジトリに存在することがリストされます:F264EF72737B35991E381047D5B43D87656640771B3C。フィールド名で降順に並べ替えます。これには、totalResultsとすべてのフィールドの例が含まれます(チャネルなど、レスポンス内のリポジトリ)。 

/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?limit=1&offset=1&totalResults=true&orderBy=name:desc&fields=all&roleName=manager

レスポンス本文 

{
    "hasMore": true,
    "offset": 1,
    "count": 2,
    "limit": 4,
    "totalResults": 4,
    "items": [{
    "id": "O8BDF919B2A16305DC4FE1E5059C53173092B7A2B7A6",
    "repository": {
      "id": "F264EF72737B35991E381047D5B43D87656640771B3C",
      "name": "repository4",
      "role": "manager"
    },
    "name": "collection3",
    "description": "",
    "createdBy": "marketing.user",
    "createdDate": {
      "value": "2018-12-13T10:31:24.892Z",
      "timezone": "UTC"
    },
    "updatedBy": "marketing.user",
    "updatedDate": {
      "value": "2018-12-13T10:31:24.892Z",
      "timezone": "UTC"
    },
    "channels": [],
    "links": [{
      "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/O8BDF919B2A16305DC4FE1E5059C53173092B7A2B7A6",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }, {
    "id": "OB19FE8746BD86E83DA44EF1FA5ED83E361FEC1D24C4",
    "repository": {
      "id": "F264EF72737B35991E381047D5B43D87656640771B3C",
      "name": "repository4",
      "role": "manager"
    },
    "name": "collection2",
    "description": "",
    "createdBy": "marketing.user",
    "createdDate": {
      "value": "2018-12-13T10:01:17.054Z",
      "timezone": "UTC"
    },
    "updatedBy": "marketing.user",
    "updatedDate": {
      "value": "2018-12-13T10:01:17.054Z",
      "timezone": "UTC"
    },
    "channels": [],
    "links": [{
      "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections/OB19FE8746BD86E83DA44EF1FA5ED83E361FEC1D24C4",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }
    ],
    "links": [{
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?totalResults=true&offset=1&limit=2&roleName=manager&orderBy=name:desc&fields=all",
    "rel": "self",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?totalResults=true&offset=1&limit=2&roleName=manager&orderBy=name:desc&fields=all",
    "rel": "canonical",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/metadata-catalog/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections",
    "rel": "describedby",
    "method": "GET",
    "mediaType": "application/schema+json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?totalResults=true&offset=0&limit=2&roleName=manager&orderBy=name:desc&fields=all",
    "rel": "prev",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?totalResults=true&offset=3&limit=2&roleName=manager&orderBy=name:desc&fields=all",
    "rel": "next",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?totalResults=true&offset=0&limit=2&roleName=manager&orderBy=name:desc&fields=all",
    "rel": "first",
    "method": "GET",
    "mediaType": "application/json"
    }, {
    "href": "https://host:port/content/management/api/v1.1/repositories/F264EF72737B35991E381047D5B43D87656640771B3C/collections?totalResults=true&offset=3&limit=2&roleName=manager&orderBy=name:desc&fields=all",
    "rel": "last",
    "method": "GET",
    "mediaType": "application/json"
    }
    ]
    }
先頭に戻る