機械翻訳について

移動先

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

アイテムの読取り一括操作公開アイテムId

get

/content/management/api/v1.1/bulkItemsOperations/publish/{statusId}/ids

リクエスト

パス・パラメータ

• statusId: string
  一括アイテム公開操作のステータスId。

問合せパラメータ

• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

  デフォルト値: 100
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
• offset(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。

  デフォルト値: 0
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : PublishItemIds

型: object

アイテムIdを公開します。

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/PublishedItemId"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Publish Item ids."
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

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

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object PublishedItemId
  公表アイテムId

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/PublishedItemId"
    }
}

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

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : 殺害

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• name(optional): string
  読取り専用: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

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

型: object

公表アイテムId

ソースを表示

• channels(optional): array channels
  channels
• id(optional): string
• links(optional): array links
  リンク
• slug(optional): string
• status(optional): string
  status
• type(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "slug":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"status"
        },
        "channels":{
            "type":"array",
            "description":"channels",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Publish Item Id"
}

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

型: array

channels

ソースを表示

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"channels",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

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

型: object

ChannelId

ソースを表示

• id(optional): string
• isPrimaryChannel(optional): boolean
  チャネルがアセットのプライマリかどうかを示します。
• links(optional): array links
  リンク
• name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

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

ネストされたスキーマ: 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リクエストの送信による、アイテムの一括操作の公開アイテムidの取得方法を示しています。

curl -i -X GET -H 'Accept:application/json' 'https://host:port/content/management/api/v1.1/bulkItemsOperations/publish/{statusId}/ids'

例1:

これは、操作IDによる成功したアイテムの一括操作の公開アイテムIDを読み取ります: OPC12C04D0F3A84DC8974BF66BD7069EA1。

/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 2,
        "items": [
          {
            "id": "CORED5710B874C0E459D9C5C87193FD7C36A",
            "type": "Type1",
            "version": "1",
            "slug": "1481786051169-item1",
            "channels": [
              {
                "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CORED5710B874C0E459D9C5C87193FD7C36A?channelToken=ce83127a4a7b7438ec2d9400fafecf0a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          },
          {
            "id": "CONT86B1B61854A747D9BB4901903A98D2DF",
            "type": "DigitalAsset",
            "version": "1",
            "channels": [
              {
                "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CONT86B1B61854A747D9BB4901903A98D2DF?channelToken=ce83127a4a7b7438ec2d9400fafecf0a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
}
  

例2:

これは、オフセットから開始する操作IDで成功したアイテム一括操作の公開アイテムIDを読み取ります1: OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1。

/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1

レスポンス本文

{
        "hasMore": false,
        "offset": 1,
        "count": 1,
        "limit": 2,
        "items": [
          {
            "id": "CONT86B1B61854A747D9BB4901903A98D2DF",
            "type": "DigitalAsset",
            "version": "1",
            "channels": [
              {
                "id": "CC66DC0B9245E2F3712BC9B0211DC4BED717C50B6929"
              }
            ],
            "links": [
              {
                "href": "https://<hostname>/content/published/api/v1.1/items/CONT86B1B61854A747D9BB4901903A98D2DF?channelToken=ce83127a4a7b7438ec2d9400fafecf0a",
                "rel": "self",
                "method": "GET",
                "mediaType": "application/json"
              }
            ]
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/schema+json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "prev",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/bulkItemsOperations/publish/OPC12C04D0F3A84DC8974BF66BD7069EA1/ids?offset=1",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
}
  

先頭に戻る