機械翻訳について

移動先

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

アイテムのパブリッシュ情報の読取り

get

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

指定されたアイテムの公開情報を読み取ります。

リクエスト

パス・パラメータ

• id: string
  アイテムのId。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : ItemSubResourceListPublishInfo

型: 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/PublishInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

型: array

ソースを表示

• Array of: object PublishInfo
  PublishInfo

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

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

型: array

ソースを表示

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

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

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

型: object

PublishInfo

ソースを表示

• channel (オプション): string
  ターゲット名
• links(optional): array links
  リンク
• publishedBy(optional): string
  パブリッシュしたユーザー
• publishedDate(optional): object date
  date
• slug(optional): string
  公開スラグ
• version(optional): string
  公開済のバージョン

{
    "type":"object",
    "properties":{
        "channel":{
            "type":"string",
            "description":"Target name"
        },
        "publishedBy":{
            "type":"string",
            "description":"Published by"
        },
        "version":{
            "type":"string",
            "description":"Published version"
        },
        "publishedDate":{
            "description":"date and time Item publishedAt.",
            "$ref":"#/definitions/date"
        },
        "slug":{
            "type":"string",
            "description":"Published slug"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PublishInfo"
}

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

型: array

リンク

ソースを表示

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

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

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

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

ネストされたスキーマ: 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}/publishInfo'

例:

この読取りは、アイテムidの公開情報を読み取ります: COREB423D3839C634CD485B76C696E58C41F。

/content/management/api/v1.1/items/COREB423D3839C634CD485B76C696E58C41F/publishInfo

レスポンス本文

{
    "data": [
    {
      "channel": "CC7F904D19025B10A1CCEB3310EE70D4C814DBFED3B2",
      "publishedBy": "marketing.user",
      "version": "1",
      "publishedDate": {
        "value": "2018-12-03T09:50:21.705Z",
        "timezone": "UTC"
    }
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/items/COREB423D3839C634CD485B76C696E58C41F/publishInfo",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }

先頭に戻る