機械翻訳について

移動先

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

タクソノミの公開を取り消す

post

/content/management/api/v1.1/taxonomies/{id}/unpublish

選択したチャネルから。 選択したチャネルではタクソノミは使用できなくなり、アセットに対する既存のカテゴリ分け情報も削除されます。 ユーザーは、選択したチャネル上でコントリビュータである必要があります。 タクソノミでアクティブ化できるのは、一度に1つの非公開リクエストまたは公開リクエストのみです。 未公開のままタクソノミが進行中の場合、後続のリクエストは最初の未公開が完了するまで失敗します。

リクエスト

パス・パラメータ

• id: string
  タクソノミのId。

問合せパラメータ

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

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

タクソノミは、リクエスト・ペイロードの公開を解除しています。 現在、publishedのタクソノミのみを公開できます。そのため、statusおよびversionは使用しません。 これは非同期的な操作です。 非同期リクエストは、ロケーション・ヘッダーにステータス・リンクがある202ステータスで応答します。

ルート・スキーマ : TaxonomyOperationUnPublishRequest

型: object

タクソノミ操作UnPublishリクエスト

ソースを表示

• channels(optional): array channels
  公開取消チャネルのリスト。 チャネルが空でない場合、タクソノミは指定されたチャネルから公開されません。 リスト内のチャネルのみが、タクソノミの公開取消に使用されます。 パラメータ・チャネルは必須で、空の場合はエラー・メッセージが返されます。
• status(optional): string
  タクソノミのステータス(ドラフト/促進済)。 公開されたタクソノミのみを非公開にできるため、これは未公開のリクエストでは無視されます。
• version(optional): integer(int32)
  タクソノミのバージョン。 現在、バージョン・フィールドは無視されます。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the Taxonomy (draft/promoted). This is ignored for unpublishing request since only published taxonomies can be unpublished."
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "description":"Version of a Taxonomy. The version field is currently ignored."
        },
        "channels":{
            "type":"array",
            "description":"List of unpublish channels. If channels is not empty, taxonomy is unpublished from given channels. Only channels in the list will be used to unpublish the taxonomy. Parameter channels is mandatory and, in case it is empty, an error message will be returned.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        }
    },
    "description":"Taxonomy Operation UnPublish Request"
}

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

型: array

公開取消チャネルのリスト。 チャネルが空でない場合、タクソノミは指定されたチャネルから公開されません。 リスト内のチャネルのみが、タクソノミの公開取消に使用されます。 パラメータ・チャネルは必須で、空の場合はエラー・メッセージが返されます。

ソースを表示

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of unpublish channels. If channels is not empty, taxonomy is unpublished from given channels. Only channels in the list will be used to unpublish the taxonomy. Parameter channels is mandatory and, in case it is empty, an error message will be returned.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

ネストされたスキーマ : 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."
}

トップに戻る

レスポンス

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

• application/json

202レスポンス

Accepted.

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

タクソノミが見つかりません。 リクエストしたリソースが見つかりません。

409レスポンス

リクエストされたリソース操作は一時的に使用できません

500レスポンス

内部サーバー・エラー

先頭に戻る