機械翻訳について

移動先

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

編集ロールでのすべての権限の表示

get

/content/management/api/v1.1/editorialRoles/{roleId}/permissions

カスタム編集ロールに対するすべての権限をリストします。

リクエスト

パス・パラメータ

• roleId: string
  カスタム編集ロールのID。

問合せパラメータ

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

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

  デフォルト値: 0
• orderBy(optional): string
  このパラメータは、結果の順序を制御するために使用します。 この問合せパラメータの値はfieldName:[asc/desc]の形式に従います。「昇順」は、昇順「説明」の場合は降順、デフォルトの順序は「昇順」です。フィールド名で使用できるフィールドは、fullNameとtypeのみです。

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

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : ResourcePermissions

型: object

ResourcePermissions

ソースを表示

• 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/ResourcePermission"
            }
        },
        "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":"ResourcePermissions"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

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

型: array

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

ソースを表示

• Array of: object ResourcePermission
  ResourcePermission

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

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

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

型: object

ResourcePermission

ソースを表示

• email(optional): string
  ユーザーの電子メール。
• fullName(optional): string
  ユーザーの完全名。
• groupType(optional): string
  許容値: [ "CEC", "IDP" ]

  グループのタイプ。
• id(optional): string
  ユーザーのuserIdログイン名。
• links(optional): array links
  読取り専用: true

  リンク
• role(optional): object PermissionRole
  PermissionRole
• roleName(optional): string
  リソース上のロールの名前。 非推奨。 'role'プロパティに置き換えられます。
• type(optional): string
  許容値: [ "user", "group" ]

  ユーザーのタイプ。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"userId login name of the user."
        },
        "roleName":{
            "type":"string",
            "description":"name of the role on the resource. Deprecated. Replaced by the 'role' property."
        },
        "role":{
            "description":"role on the resource.",
            "$ref":"#/definitions/PermissionRole"
        },
        "type":{
            "type":"string",
            "description":"type of the user.",
            "enum":[
                "user",
                "group"
            ]
        },
        "groupType":{
            "type":"string",
            "description":"type of the group.",
            "enum":[
                "CEC",
                "IDP"
            ]
        },
        "email":{
            "type":"string",
            "description":"email of the user."
        },
        "fullName":{
            "type":"string",
            "description":"full name of the user."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ResourcePermission"
}

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

型: array

読取り専用: true

リンク

ソースを表示

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

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

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

型: object

PermissionRole

ソースを表示

• description(optional): string
  ロールの説明。 カスタムの編集ロールまたは公開ロールにのみ適用されます。
• id(optional): string
  ロールのID。 権限セット、カスタム編集ロールまたは公開ロールにのみ適用されます。
• links(optional): array links
  リンク
• name(optional): string
  ロールの名前。
• type(optional): string
  許容値: [ "standard", "custom", "editorial", "publishing" ]

  ロールのタイプ。 値は、'standard'、'custom'、'editorial'および'publishing'です。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the role. Only applicable to permission sets and custom editorial or publishing roles."
        },
        "name":{
            "type":"string",
            "description":"Name of the role."
        },
        "type":{
            "type":"string",
            "description":"Type of the role. Values are 'standard', 'custom', 'editorial', and 'publishing'.",
            "enum":[
                "standard",
                "custom",
                "editorial",
                "publishing"
            ]
        },
        "description":{
            "type":"string",
            "description":"Description of the role. Only applicable to custom editorial or publishing roles."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"PermissionRole"
}

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

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

型: array

リンク

ソースを表示

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

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

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してGETリクエストを発行して、編集ロール権限をリストする方法を示しています。

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

例

/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions

編集ロール権限をリストします。 ここで、7A58B07965C54543B7C0517562DDC313は編集ロールのIDです。

レスポンス本文

{
        "hasMore": false,
        "offset": 0,
        "count": 2,
        "limit": 2,
        "items": [
          {
            "id": "cecuserLoginIdName1",
            "roleName": "manager",
            "type": "user",
            "email": "email1",
            "fullName": "cecuser1"
          },
          {
            "id": "cecgroupLoginIdName2",
            "roleName": "manager",
            "type": "group",
            "email": "email2",
            "fullName": "cecgroup2"
          }
        ],
        "links": [
          {
            "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions",
            "rel": "self",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions",
            "rel": "canonical",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions",
            "rel": "describedby",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions?offset=0",
            "rel": "first",
            "method": "GET",
            "mediaType": "application/json"
          },
          {
            "href": "https://<hostname>/content/management/api/v1.1/editorialRoles/7A58B07965C54543B7C0517562DDC313/permissions?offset=0",
            "rel": "last",
            "method": "GET",
            "mediaType": "application/json"
          }
        ]
      }

先頭に戻る