機械翻訳について

移動先

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

チャネルの読取り

get

/content/management/api/v1.1/channels/{id}

チャネルを読み取ります。

リクエスト

パス・パラメータ

• id: string
  チャネルのId。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

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

型: 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"
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してRESTリソースにGETリクエストを発行することで、そのIDを使用してチャネル詳細を取得する方法を示しています:

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

例:

これはIdのチャネルを読み取ります: CC3CF44049B94207BE552A345E74319B10F86A56D2F7。

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

レスポンス本文

{
    "id": "CC3CF44049B94207BE552A345E74319B10F86A56D2F7",
    "name": "channelName12",
    "description": "some channel description",
    "createdBy": "marketing.user",
    "createdDate": {
    "value": "2018-11-30T10:21:31.885Z",
    "timezone": "UTC"
    },
    "updatedBy": "marketing.user",
    "updatedDate": {
    "value": "2018-11-30T10:21:31.885Z",
    "timezone": "UTC"
    },
    "channelType": "public",
    "isSiteChannel": false,
    "publishPolicy": "anythingPublished",
    "localizationPolicy": "7B8F6F008D905491E0534DB0F70AEE4C",
    "channelTokens": [
    {
      "name": "defaultToken",
      "name of the token.": "defaultToken",
      "value of the token.": "12b4e75643051cdc830b27d6d3503e44",
      "token": "12b4e75643051cdc830b27d6d3503e44",
      "expirationDate of the token.": {
        "value": "2098-12-28T00:00:00.000Z",
        "timezone": "UTC"
    },
      "expirationDate": {
        "value": "2098-12-28T00:00:00.000Z",
        "timezone": "UTC"
    }
    }
    ],
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/channels/CC3CF44049B94207BE552A345E74319B10F86A56D2F7",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/channels/CC3CF44049B94207BE552A345E74319B10F86A56D2F7",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "https://host:port/content/management/api/v1.1/metadata-catalog/channels/CC3CF44049B94207BE552A345E74319B10F86A56D2F7",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
    ]
    }

先頭に戻る