コンテンツ管理REST API

機械翻訳について

アイテムのリスト・コレクション

get

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

指定されたアイテムのすべてのコレクションをリストします。

リクエスト

パス・パラメータ

id: string

アイテムのId。

問合せパラメータ

links(optional): string

このパラメータは、リンク名のカンマ区切りのリストを受け入れます。デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

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

application/json

200レスポンス

OK。

ルート・スキーマ : ItemSubResourceListCollectionId

型: object

アイテムSubResource。

ソースを表示

data(optional): array data
links(optional): array links
totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CollectionId"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

型: array

ソースを表示

Array of: object CollectionId

CollectionId

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CollectionId"
    }
}

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

型: array

ソースを表示

Array of: object Link

リソースのリンク。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

CollectionId

ソースを表示

id(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    },
    "description":"CollectionId"
}

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

型: object

リソースのリンク。

ソースを表示

href(optional): string

ターゲット・リソースのURI それはテンプレートURIである可能性があります。これはレスポンス取得の必須プロパティです。
mediaType(optional): string

メディア・タイプ。
method(optional): string

ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
profile(optional): string

ターゲット・リソースを記述するメタデータにリンクします。
rel(optional): string

関連タイプこれはレスポンス取得の必須プロパティです。
templated(optional): boolean

URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してGETリクエストを送信することによってコレクションを取得する方法を示しています。

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

例1:

このリストには、アイテムidのすべてのコレクションが表示されます: CORE70DDEB1E83E54B6BB7BEBED43CEBC692。

/content/management/api/v1.1/items/CORE70DDEB1E83E54B6BB7BEBED43CEBC692/collections

レスポンス本文

{
    "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:

このリストには、1の索引を開始する、ロールをマネージャとして持つ最初の2コレクションが、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"
    }
    ]
    }
    }

先頭に戻る