機械翻訳について

移動先

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

チャネルの作成

post

/content/management/api/v1.1/channels

指定されたペイロードでチャネルを作成します。

リクエスト

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

• application/json

問合せパラメータ

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

ヘッダー・パラメータ

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

  許容値: [ "XMLHttpRequest" ]

本文()

ペイロード内に指定の情報でチャネルを作成します。 ペイロード内に指定されている場合でも、id、createdBy、createdDate、updatedBy、updatedDate、channelToken、isSiteChannelおよびlinksフィールドは無視されます。

ルート・スキーマ : チャネル

型: object

チャネル

ソースを表示

• channelAccessControls(optional): array channelAccessControls
  チャネル・アクセス制御のリスト。セキュアな標準チャネルでのみ許可されます。 現在、セキュア・チャネルに対してのみアクセス制御を許可しています
• channelTokens(optional): array channelTokens
  チャネルのトークンのリスト。
• channelType(optional): string
  許容値: [ "public", "secure" ]

  チャネルのタイプ。
• createdBy(optional): string
  チャネルのcreatedByユーザー。
• createdDate(optional): object date
  date
• description(optional): string
  チャネルの説明。
• id(optional): string
  チャネルのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isSiteChannel(optional): boolean
  チャネルがサイト・チャネルであるかどうかをチェックします。
• isSitePlanChannel(optional): boolean
• links(optional): array links
  リンク
• localizationPolicy(optional): string
  チャネルのローカリゼーション・ポリシー。
• name(optional): string
  チャネルの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• primaryChannelSupported(optional): boolean
  primaryChannelSupported
• publishPolicy(optional): string
  許容値: [ "anythingPublished", "onlyApproved" ]

  チャネルの公開ポリシー。
• rankingPolicyContentTypes(optional): array rankingPolicyContentTypes
  チャネルの検索ランキング・ポリシー範囲。
• rankingPolicyDescriptorId(optional): string
  チャネルの検索ランキング・ポリシー記述子ID。
• rankingPolicyDescriptorName(optional): string
  チャネルの検索ランキング・ポリシー記述子名。
• repositories(optional): array repositories
  チャネルに関連付けられたリポジトリ。 現在、サイト・チャネルのデフォルト・リポジトリのみが公開されています。
• roleName(optional): string
  チャネル上のユーザー・ロールの名前。
• updatedBy(optional): string
  チャネルのupdatedByユーザー。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel. It is a required property in the get response and post/put request."
        },
        "primaryChannelSupported":{
            "type":"boolean",
            "description":"primaryChannelSupported"
        },
        "description":{
            "type":"string",
            "description":"Description of the channel."
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the channel."
        },
        "createdDate":{
            "description":"date and time Channel createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the channel."
        },
        "updatedDate":{
            "description":"date and time Channel updatedAt.",
            "$ref":"#/definitions/date"
        },
        "channelType":{
            "type":"string",
            "description":"The type of the channel.",
            "enum":[
                "public",
                "secure"
            ]
        },
        "isSiteChannel":{
            "type":"boolean",
            "description":"Checks whether the channel is site channel."
        },
        "isSitePlanChannel":{
            "type":"boolean"
        },
        "publishPolicy":{
            "type":"string",
            "description":"The publish policy of the channel.",
            "enum":[
                "anythingPublished",
                "onlyApproved"
            ]
        },
        "localizationPolicy":{
            "type":"string",
            "description":"The localization policy of the channel."
        },
        "rankingPolicyDescriptorId":{
            "type":"string",
            "description":"The search ranking policy descriptor ID of the channel."
        },
        "rankingPolicyDescriptorName":{
            "type":"string",
            "description":"The search ranking policy descriptor name of the channel."
        },
        "rankingPolicyContentTypes":{
            "type":"array",
            "description":"The search ranking policy scope of the channel.",
            "items":{
                "type":"string"
            }
        },
        "channelTokens":{
            "type":"array",
            "description":"A list of tokens for the channel.",
            "items":{
                "$ref":"#/definitions/channelToken"
            }
        },
        "channelAccessControls":{
            "type":"array",
            "description":"A list of channel access controls, allowed only for a secure regular channel. It currently allows the access control only for secure channels",
            "items":{
                "$ref":"#/definitions/channelAccessControls"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the channel."
        },
        "repositories":{
            "type":"array",
            "description":"Repositories associated with the channel. It currently exposes only the default repository for a site channel.",
            "items":{
                "$ref":"#/definitions/RepositoryId"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Channels"
}

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

型: array

チャネル・アクセス制御のリスト。セキュアな標準チャネルでのみ許可されます。 現在、セキュア・チャネルに対してのみアクセス制御を許可しています

ソースを表示

• Array of: object channelAccessControls
  channelAccessControls

{
    "type":"array",
    "description":"A list of channel access controls, allowed only for a secure regular channel. It currently allows the access control only for secure channels",
    "items":{
        "$ref":"#/definitions/channelAccessControls"
    }
}

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

型: array

チャネルのトークンのリスト。

ソースを表示

• Array of: object channelToken
  channelToken

{
    "type":"array",
    "description":"A list of tokens for the channel.",
    "items":{
        "$ref":"#/definitions/channelToken"
    }
}

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

型: object

date

ソースを表示

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

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

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

型: array

リンク

ソースを表示

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

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

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

型: array

チャネルの検索ランキング・ポリシー範囲。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"The search ranking policy scope of the channel.",
    "items":{
        "type":"string"
    }
}

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

型: array

チャネルに関連付けられたリポジトリ。 現在、サイト・チャネルのデフォルト・リポジトリのみが公開されています。

ソースを表示

• Array of: object RepositoryId
  RepositoryId

{
    "type":"array",
    "description":"Repositories associated with the channel. It currently exposes only the default repository for a site channel.",
    "items":{
        "$ref":"#/definitions/RepositoryId"
    }
}

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

型: object

channelAccessControls

ソースを表示

• type(optional): string
  許容値: [ "CLOUD_USERS", "SERVICE_USERS", "SPECIFIC_USERS" ]

  付与されるアクセス制御タイプ、指定可能な値はCLOUD_USERS、SERVICE_USERS、SPECIFIC_USERS、デフォルトはCLOUD_USERSです
• users(optional): array users
  チャネル・アクセス制御が提供される特定のユーザーで、アクセス制御タイプがSPECIFC_USERSの場合にのみ許可されます

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Access Control Type to be granted, possible values are CLOUD_USERS, SERVICE_USERS, SPECIFIC_USERS and defaults to CLOUD_USERS",
            "enum":[
                "CLOUD_USERS",
                "SERVICE_USERS",
                "SPECIFIC_USERS"
            ]
        },
        "users":{
            "type":"array",
            "description":"Specific users to which channel access control is provided, allowed only if the access control type is SPECIFC_USERS",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"channelAccessControls"
}

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

型: array

チャネル・アクセス制御が提供される特定のユーザーで、アクセス制御タイプがSPECIFC_USERSの場合にのみ許可されます

ソースを表示

• Array of: object UserId
  UserId

{
    "type":"array",
    "description":"Specific users to which channel access control is provided, allowed only if the access control type is SPECIFC_USERS",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

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

型: object

UserId

ソースを表示

• groupType(optional): string
  許容値: [ "CEC", "IDP" ]
• name(optional): string
• type(optional): string
  許容値: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"UserId"
}

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

型: object

channelToken

ソースを表示

• expirationDate(optional): object date
  date
• name(optional): string
  トークンの名前。
• token(optional): string
  トークンの値。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the token."
        },
        "token":{
            "type":"string",
            "description":"Value of the token."
        },
        "expirationDate":{
            "description":"ExpirationDate of the token.",
            "$ref":"#/definitions/date"
        }
    },
    "description":"channelToken"
}

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

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

型: object

RepositoryId

ソースを表示

• id(optional): string
• name(optional): string
  リポジトリの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the repository. It is a required property in the get response and post/put request."
        }
    },
    "description":"RepositoryId"
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : チャネル

型: object

チャネル

ソースを表示

• channelAccessControls(optional): array channelAccessControls
  チャネル・アクセス制御のリスト。セキュアな標準チャネルでのみ許可されます。 現在、セキュア・チャネルに対してのみアクセス制御を許可しています
• channelTokens(optional): array channelTokens
  チャネルのトークンのリスト。
• channelType(optional): string
  許容値: [ "public", "secure" ]

  チャネルのタイプ。
• createdBy(optional): string
  チャネルのcreatedByユーザー。
• createdDate(optional): object date
  date
• description(optional): string
  チャネルの説明。
• id(optional): string
  チャネルのId。 これはレスポンス取得と送信リクエストの必須プロパティであり、リクエストの転送には必要ありません。
• isSiteChannel(optional): boolean
  チャネルがサイト・チャネルであるかどうかをチェックします。
• isSitePlanChannel(optional): boolean
• links(optional): array links
  リンク
• localizationPolicy(optional): string
  チャネルのローカリゼーション・ポリシー。
• name(optional): string
  チャネルの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。
• primaryChannelSupported(optional): boolean
  primaryChannelSupported
• publishPolicy(optional): string
  許容値: [ "anythingPublished", "onlyApproved" ]

  チャネルの公開ポリシー。
• rankingPolicyContentTypes(optional): array rankingPolicyContentTypes
  チャネルの検索ランキング・ポリシー範囲。
• rankingPolicyDescriptorId(optional): string
  チャネルの検索ランキング・ポリシー記述子ID。
• rankingPolicyDescriptorName(optional): string
  チャネルの検索ランキング・ポリシー記述子名。
• repositories(optional): array repositories
  チャネルに関連付けられたリポジトリ。 現在、サイト・チャネルのデフォルト・リポジトリのみが公開されています。
• roleName(optional): string
  チャネル上のユーザー・ロールの名前。
• updatedBy(optional): string
  チャネルのupdatedByユーザー。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the channel. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"Name of the channel. It is a required property in the get response and post/put request."
        },
        "primaryChannelSupported":{
            "type":"boolean",
            "description":"primaryChannelSupported"
        },
        "description":{
            "type":"string",
            "description":"Description of the channel."
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the channel."
        },
        "createdDate":{
            "description":"date and time Channel createdAt.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the channel."
        },
        "updatedDate":{
            "description":"date and time Channel updatedAt.",
            "$ref":"#/definitions/date"
        },
        "channelType":{
            "type":"string",
            "description":"The type of the channel.",
            "enum":[
                "public",
                "secure"
            ]
        },
        "isSiteChannel":{
            "type":"boolean",
            "description":"Checks whether the channel is site channel."
        },
        "isSitePlanChannel":{
            "type":"boolean"
        },
        "publishPolicy":{
            "type":"string",
            "description":"The publish policy of the channel.",
            "enum":[
                "anythingPublished",
                "onlyApproved"
            ]
        },
        "localizationPolicy":{
            "type":"string",
            "description":"The localization policy of the channel."
        },
        "rankingPolicyDescriptorId":{
            "type":"string",
            "description":"The search ranking policy descriptor ID of the channel."
        },
        "rankingPolicyDescriptorName":{
            "type":"string",
            "description":"The search ranking policy descriptor name of the channel."
        },
        "rankingPolicyContentTypes":{
            "type":"array",
            "description":"The search ranking policy scope of the channel.",
            "items":{
                "type":"string"
            }
        },
        "channelTokens":{
            "type":"array",
            "description":"A list of tokens for the channel.",
            "items":{
                "$ref":"#/definitions/channelToken"
            }
        },
        "channelAccessControls":{
            "type":"array",
            "description":"A list of channel access controls, allowed only for a secure regular channel. It currently allows the access control only for secure channels",
            "items":{
                "$ref":"#/definitions/channelAccessControls"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the channel."
        },
        "repositories":{
            "type":"array",
            "description":"Repositories associated with the channel. It currently exposes only the default repository for a site channel.",
            "items":{
                "$ref":"#/definitions/RepositoryId"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Channels"
}

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

型: array

チャネル・アクセス制御のリスト。セキュアな標準チャネルでのみ許可されます。 現在、セキュア・チャネルに対してのみアクセス制御を許可しています

ソースを表示

• Array of: object channelAccessControls
  channelAccessControls

{
    "type":"array",
    "description":"A list of channel access controls, allowed only for a secure regular channel. It currently allows the access control only for secure channels",
    "items":{
        "$ref":"#/definitions/channelAccessControls"
    }
}

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

型: array

チャネルのトークンのリスト。

ソースを表示

• Array of: object channelToken
  channelToken

{
    "type":"array",
    "description":"A list of tokens for the channel.",
    "items":{
        "$ref":"#/definitions/channelToken"
    }
}

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

型: object

date

ソースを表示

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

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

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

型: array

リンク

ソースを表示

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

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

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

型: array

チャネルの検索ランキング・ポリシー範囲。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"The search ranking policy scope of the channel.",
    "items":{
        "type":"string"
    }
}

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

型: array

チャネルに関連付けられたリポジトリ。 現在、サイト・チャネルのデフォルト・リポジトリのみが公開されています。

ソースを表示

• Array of: object RepositoryId
  RepositoryId

{
    "type":"array",
    "description":"Repositories associated with the channel. It currently exposes only the default repository for a site channel.",
    "items":{
        "$ref":"#/definitions/RepositoryId"
    }
}

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

型: object

channelAccessControls

ソースを表示

• type(optional): string
  許容値: [ "CLOUD_USERS", "SERVICE_USERS", "SPECIFIC_USERS" ]

  付与されるアクセス制御タイプ、指定可能な値はCLOUD_USERS、SERVICE_USERS、SPECIFIC_USERS、デフォルトはCLOUD_USERSです
• users(optional): array users
  チャネル・アクセス制御が提供される特定のユーザーで、アクセス制御タイプがSPECIFC_USERSの場合にのみ許可されます

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Access Control Type to be granted, possible values are CLOUD_USERS, SERVICE_USERS, SPECIFIC_USERS and defaults to CLOUD_USERS",
            "enum":[
                "CLOUD_USERS",
                "SERVICE_USERS",
                "SPECIFIC_USERS"
            ]
        },
        "users":{
            "type":"array",
            "description":"Specific users to which channel access control is provided, allowed only if the access control type is SPECIFC_USERS",
            "items":{
                "$ref":"#/definitions/UserId"
            }
        }
    },
    "description":"channelAccessControls"
}

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

型: array

チャネル・アクセス制御が提供される特定のユーザーで、アクセス制御タイプがSPECIFC_USERSの場合にのみ許可されます

ソースを表示

• Array of: object UserId
  UserId

{
    "type":"array",
    "description":"Specific users to which channel access control is provided, allowed only if the access control type is SPECIFC_USERS",
    "items":{
        "$ref":"#/definitions/UserId"
    }
}

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

型: object

UserId

ソースを表示

• groupType(optional): string
  許容値: [ "CEC", "IDP" ]
• name(optional): string
• type(optional): string
  許容値: [ "user", "group" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "enum":[
                "CEC",
                "IDP"
            ]
        }
    },
    "description":"UserId"
}

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

型: object

channelToken

ソースを表示

• expirationDate(optional): object date
  date
• name(optional): string
  トークンの名前。
• token(optional): string
  トークンの値。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the token."
        },
        "token":{
            "type":"string",
            "description":"Value of the token."
        },
        "expirationDate":{
            "description":"ExpirationDate of the token.",
            "$ref":"#/definitions/date"
        }
    },
    "description":"channelToken"
}

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

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

型: object

RepositoryId

ソースを表示

• id(optional): string
• name(optional): string
  リポジトリの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the repository. It is a required property in the get response and post/put request."
        }
    },
    "description":"RepositoryId"
}

400レスポンス

不正リクエスト

403レスポンス

禁止。

409レスポンス

競合

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してRESTリソースにPOSTリクエストを発行することによってチャネルを作成する方法を示します。

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/channels'

例1:

これにより、既存のローカリゼーション・ポリシーを持つパブリック・チャネルが作成されます。ここで、7B8F6F008D905491E0534DB0F70AEE4Cは既存のローカリゼーション・ポリシーidです。 ペイロードを独自のデータで置換します。

/content/management/api/v1.1/channels

リクエスト本文

{
  "name": "channel5",
  "description": "channel5 description",
  "channelType": "public",
  "localizationPolicy": "7B8F6F008D905491E0534DB0F70AEE4C"
}

例2:

これにより、既存のローカリゼーション・ポリシーを使用してパブリック・チャネルが作成され、publishPolicyが公開できるのは承認済アイテムのみです。7B8F6F008D905491E0534DB0F70AEE4Cは既存のローカリゼーション・ポリシーidです。 ペイロードを独自のデータで置換します。

/content/management/api/v1.1/channels

リクエスト本文

{
  "name": "channel6",
  "description": "channel6 description",
  "channelType": "public",
  "publishPolicy": "onlyApproved",
  "localizationPolicy": "7B8F6F008D905491E0534DB0F70AEE4C"
}

先頭に戻る