機械翻訳について

移動先

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

リポジトリ編集ロールの読取り

get

/content/management/api/v1.1/repositories/{id}/editorialRoles/{roleId}

リポジトリの下のカスタム編集ロールを読み取ります。 編集ロールはリポジトリに割り当てる必要があります。

リクエスト

パス・パラメータ

• id: string
  リポジトリのId。
• roleId: string
  カスタム編集ロールのID。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : EditorialRole

型: object

EditorialRole

ソースを表示

• contentPrivileges(optional): array contentPrivileges
  カスタム編集ロールによって定義されたアセット・タイプの権限。
• createdBy(optional): string
  カスタム編集ロールのユーザーによって作成されます。
• createdDate(optional): object date
  date
• description(optional): string
  カスタム編集ロールの説明。
• hasPrivilegeGranted(optional): boolean
  カスタム編集ロールが特定のリポジトリのコンテキストで任意の権限を付与するかどうか。
• id(optional): string
  カスタム編集ロールのID。
• isUsed(optional): boolean
  特定のリポジトリでカスタム編集ロールが使用されているかどうか。
• links(optional): array links
  カスタム編集ロール・リソースのリンク。
• name(optional): string
  カスタム編集ロールの名前。
• roleName(optional): string
  カスタム編集ロールのユーザー・ロールの名前。
• taxonomyPrivileges(optional): array taxonomyPrivileges
  カスタム編集ロールによって定義されたタクソノミの権限。
• updatedBy(optional): string
  カスタム編集ロールのユーザーによって更新されました。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of a custom editorial role."
        },
        "name":{
            "type":"string",
            "description":"Name of a custom editorial role."
        },
        "description":{
            "type":"string",
            "description":"Description of a custom editorial role."
        },
        "createdBy":{
            "type":"string",
            "description":"Created by user of a custom editorial role."
        },
        "createdDate":{
            "description":"Created date and time of a custom editorial role.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"Updated by user of a custom editorial role."
        },
        "updatedDate":{
            "description":"Updated date and time of a custom editorial role.",
            "$ref":"#/definitions/date"
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on a custom editorial role."
        },
        "isUsed":{
            "type":"boolean",
            "description":"Whether a custom editorial role is being used by a given repository."
        },
        "hasPrivilegeGranted":{
            "type":"boolean",
            "description":"Whether a custom editorial role grants any privilege under the context of a given repository."
        },
        "contentPrivileges":{
            "type":"array",
            "description":"The privileges of asset type defined by a custom editorial role.",
            "items":{
                "$ref":"#/definitions/ContentPrivilege"
            }
        },
        "taxonomyPrivileges":{
            "type":"array",
            "description":"The privileges of taxonomy defined by a custom editorial role.",
            "items":{
                "$ref":"#/definitions/TaxonomyPrivilege"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of a custom editorial role resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"EditorialRole"
}

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

型: array

カスタム編集ロールによって定義されたアセット・タイプの権限。

ソースを表示

• Array of: object ContentPrivilege
  ContentPrivilege

{
    "type":"array",
    "description":"The privileges of asset type defined by a custom editorial role.",
    "items":{
        "$ref":"#/definitions/ContentPrivilege"
    }
}

ネストされたスキーマ : 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 of a custom editorial role resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

カスタム編集ロールによって定義されたタクソノミの権限。

ソースを表示

• Array of: object TaxonomyPrivilege
  TaxonomyPrivilege

{
    "type":"array",
    "description":"The privileges of taxonomy defined by a custom editorial role.",
    "items":{
        "$ref":"#/definitions/TaxonomyPrivilege"
    }
}

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

型: object

ContentPrivilege

ソースを表示

• isEnabled(optional): boolean
  リポジトリのコンテキストで権限が有効かどうか。
• isValid(optional): boolean
  特権の有効性。
• operations(optional): array operations
  Operations
• typeDisplayName(optional): string
  コンテンツ・タイプの表示名。
• typeId(optional): string
  コンテンツ・タイプのID。
• typeName(optional): string
  コンテンツ・タイプの名前。

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string",
            "description":"The id of the content type."
        },
        "typeName":{
            "type":"string",
            "description":"The name of the content type."
        },
        "typeDisplayName":{
            "type":"string",
            "description":"The display name of the content type."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "update",
                    "create",
                    "delete"
                ]
            }
        }
    },
    "description":"ContentPrivilege"
}

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

型: array

Operations

ソースを表示

• Array of: string
  許容値: [ "view", "update", "create", "delete" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "update",
            "create",
            "delete"
        ]
    }
}

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

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

型: object

TaxonomyPrivilege

ソースを表示

• categoryId(optional): string
  カテゴリのid。
• isEnabled(optional): boolean
  リポジトリのコンテキストで権限が有効かどうか。
• isForSiteManagement(optional): boolean
  タクソノミがサイト管理用かどうか。
• isSiteCategory(optional): boolean
  カテゴリがサイト・カテゴリかどうか。
• isValid(optional): boolean
  特権の有効性。
• nodes(optional): array nodes
  カテゴリのパス。
• operations(optional): array operations
  Operations
• taxonomyId(optional): string
  タクソノミのId。
• taxonomyShortName(optional): string
  タクソノミの短縮名。

{
    "type":"object",
    "properties":{
        "taxonomyId":{
            "type":"string",
            "description":"The id of the taxonomy."
        },
        "taxonomyShortName":{
            "type":"string",
            "description":"The short name of the taxonomy."
        },
        "isForSiteManagement":{
            "type":"boolean",
            "description":"Whether the taxonomy is for site management."
        },
        "categoryId":{
            "type":"string",
            "description":"The id of the category."
        },
        "nodes":{
            "type":"array",
            "description":"The path of the category.",
            "items":{
                "$ref":"#/definitions/CategoryNodeBean"
            }
        },
        "isSiteCategory":{
            "type":"boolean",
            "description":"Whether the category is a site category."
        },
        "isValid":{
            "type":"boolean",
            "description":"The validness of the privilege."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"Whether the privilege is enabled under the context of a repository."
        },
        "operations":{
            "type":"array",
            "description":"Operations.",
            "items":{
                "type":"string",
                "enum":[
                    "view",
                    "categorize",
                    "createsite"
                ]
            }
        }
    },
    "description":"TaxonomyPrivilege"
}

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

型: array

カテゴリのパス。

ソースを表示

• Array of: object CategoryNodeBean

{
    "type":"array",
    "description":"The path of the category.",
    "items":{
        "$ref":"#/definitions/CategoryNodeBean"
    }
}

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

型: array

Operations

ソースを表示

• Array of: string
  許容値: [ "view", "categorize", "createsite" ]

{
    "type":"array",
    "description":"Operations.",
    "items":{
        "type":"string",
        "enum":[
            "view",
            "categorize",
            "createsite"
        ]
    }
}

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

型: object

ソースを表示

• apiName(optional): string
  カテゴリ・ノードのapiName。
• id(optional): string
  カテゴリ・ノードのid。
• name(optional): string
  カテゴリ・ノードの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the Category node."
        },
        "name":{
            "type":"string",
            "description":"The name of the Category node."
        },
        "apiName":{
            "type":"string",
            "description":"The apiName of the Category node."
        }
    }
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してGETリクエストを発行して、リポジトリの下のカスタム編集ロールを読み取る方法を示しています。

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

例

/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05

これは、IDが7F289D0F4FD44C0382A83EFD44A355C0のリポジトリにあるIDが76F2903A0C8E48BCA222E68264BE1E05のカスタム編集ロールを読み取ります。 タイプ・ルールにリポジトリに割り当てられていないタイプがある場合、またはタクソノミ・ルールにリポジトリに割り当てられていないタクソノミがある場合、そのルールは無効としてマークされます。

レスポンス本文

 {
  "id": "76F2903A0C8E48BCA222E68264BE1E05",
  "name": "Role 1019B",
  "description": "desc",
  "createdBy": "cecuser1",
  "createdDate": {
    "value": "2021-10-19T18:51:24.223Z",
    "timezone": "UTC"
  },
  "updatedBy": "cecuser1",
  "updatedDate": {
    "value": "2021-10-19T18:51:24.223Z",
    "timezone": "UTC"
  },
  "isUsed": true,
  "hasPrivilegeGranted": true,
  "contentPrivileges": [
    {
      "typeId": "",
      "typeName": null,
      "typeDisplayName": null,
      "isValid": true,
      "isEnabled": true,
      "operations": [
        "view"
      ]
    },
    {
      "typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
      "typeName": "Image",
      "typeDisplayName": "Image",
      "isValid": true,
      "isEnabled": true,
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    },
    {
      "typeId": "49B267B515C84AD7903C5B9C34EDB09E",
      "typeName": "TypeAAA",
      "typeDisplayName": "TypeAAA",
      "isValid": true,
      "isEnabled": true,
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    },
    {
      "typeId": "8CB7D974CBB74923BF40A6CA68BED145",
      "typeName": "TypeBBB",
      "typeDisplayName": "TypeBBB",
      "isValid": true,
      "isEnabled": true,
      "operations": []
    },
    {
      "typeId": "B228AE0D8E2E41B8924C5B9FFBCAF039",
      "typeName": "TypeCCC",
      "typeDisplayName": "TypeCCC",
      "isValid": true,
      "isEnabled": false,
      "operations": [
        "view",
        "update",
        "create",
        "delete"
      ]
    }
  ],
  "taxonomyPrivileges": [
    {
      "taxonomyId": null,
      "taxonomyShortName": null,
      "isForSiteManagement": false,
      "categoryId": "",
      "nodes": null,
      "isSiteCategory": false,
      "isValid": true,
      "isEnabled": true,
      "operations": [
        "view"
      ]
    }
  ],
  "links": [
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/repositories/7F289D0F4FD44C0382A83EFD44A355C0/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}

先頭に戻る