編集ロールの作成
post
/content/management/api/v1.1/editorialRoles
指定されたペイロードでカスタム編集ロールを作成します。
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- links(optional): string
このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby
ヘッダー・パラメータ
- X-Requested-With: string
CSRF攻撃を軽減するためのカスタム・ヘッダー。許容値:
[ "XMLHttpRequest" ]
カスタム編集ロールを作成するリクエスト・ペイロードのBean。
ルート・スキーマ : EditorialRole
型:
objectEditorialRole
ソースを表示
- 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
ネストされたスキーマ : contentPrivileges
型:
arrayカスタム編集ロールによって定義されたアセット・タイプの権限。
ソースを表示
- Array of: object ContentPrivilege
ContentPrivilege
ネストされたスキーマ : taxonomyPrivileges
型:
arrayカスタム編集ロールによって定義されたタクソノミの権限。
ソースを表示
- Array of: object TaxonomyPrivilege
TaxonomyPrivilege
ネストされたスキーマ : ContentPrivilege
型:
objectContentPrivilege
ソースを表示
- isEnabled(optional): boolean
リポジトリのコンテキストで権限が有効かどうか。
- isValid(optional): boolean
特権の有効性。
- operations(optional): array operations
Operations
- typeDisplayName(optional): string
コンテンツ・タイプの表示名。
- typeId(optional): string
コンテンツ・タイプのID。
- typeName(optional): string
コンテンツ・タイプの名前。
ネストされたスキーマ: operations
型:
arrayOperations
ソースを表示
- Array of: string
許容値:
[ "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がテンプレートであるかどうか。
ネストされたスキーマ : TaxonomyPrivilege
型:
objectTaxonomyPrivilege
ソースを表示
- 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
タクソノミの短縮名。
ネストされたスキーマ: operations
型:
arrayOperations
ソースを表示
- Array of: string
許容値:
[ "view", "categorize", "createsite" ]
ネストされたスキーマ : CategoryNodeBean
型:
ソースを表示
object- apiName(optional): string
カテゴリ・ノードのapiName。
- id(optional): string
カテゴリ・ノードのid。
- name(optional): string
カテゴリ・ノードの名前。
レスポンス
サポートされているメディア・タイプ
- application/json
201レスポンス
作成されました。
ルート・スキーマ : EditorialRole
型:
objectEditorialRole
ソースを表示
- 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
ネストされたスキーマ : contentPrivileges
型:
arrayカスタム編集ロールによって定義されたアセット・タイプの権限。
ソースを表示
- Array of: object ContentPrivilege
ContentPrivilege
ネストされたスキーマ : taxonomyPrivileges
型:
arrayカスタム編集ロールによって定義されたタクソノミの権限。
ソースを表示
- Array of: object TaxonomyPrivilege
TaxonomyPrivilege
ネストされたスキーマ : ContentPrivilege
型:
objectContentPrivilege
ソースを表示
- isEnabled(optional): boolean
リポジトリのコンテキストで権限が有効かどうか。
- isValid(optional): boolean
特権の有効性。
- operations(optional): array operations
Operations
- typeDisplayName(optional): string
コンテンツ・タイプの表示名。
- typeId(optional): string
コンテンツ・タイプのID。
- typeName(optional): string
コンテンツ・タイプの名前。
ネストされたスキーマ: operations
型:
arrayOperations
ソースを表示
- Array of: string
許容値:
[ "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がテンプレートであるかどうか。
ネストされたスキーマ : TaxonomyPrivilege
型:
objectTaxonomyPrivilege
ソースを表示
- 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
タクソノミの短縮名。
ネストされたスキーマ: operations
型:
arrayOperations
ソースを表示
- Array of: string
許容値:
[ "view", "categorize", "createsite" ]
ネストされたスキーマ : CategoryNodeBean
型:
ソースを表示
object- apiName(optional): string
カテゴリ・ノードのapiName。
- id(optional): string
カテゴリ・ノードのid。
- name(optional): string
カテゴリ・ノードの名前。
400レスポンス
不正リクエスト
403レスポンス
禁止。
500レスポンス
内部サーバー・エラー
例
次の例は、cURLを使用してPOSTリクエストを送信して編集ロールを作成する方法を示しています。
curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/editorialRoles'
例1
/content/management/api/v1.1/editorialRoles
これにより、カスタム編集ロールが作成されます。 ペイロードを独自のデータで置換します。
ノート:
任意のタイプ・ルールは空のtypeIdで定義され、任意のカテゴリ・ルールは空のcategoryIdで定義されます。
リクエスト・ペイロード
{
"name": "Custom Editor Role",
"description": "role description",
"contentPrivileges": [
{
"typeId": "",
"typeName": "",
"operations": [
"view"
]
},
{
"typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
"typeName": "Image",
"operations": [
"view",
"update",
"create"
]
}
],
"taxonomyPrivileges": [
{
"taxonomyId": "",
"categoryId": "",
"operations": [
"view"
]
}
]
}
リクエスト・ヘッダー
{
"Content-Type": "application/json",
"X-Requested-With": "XMLHttpRequest"
}
レスポンス本文
{
"id": "8788B03F236340A8A2B7ADB825ED11A9",
"name": "Custom Editor Role",
"description": "role description",
"createdBy": "cecuser1",
"createdDate": {
"value": "2021-09-13T19:02:39.947Z",
"timezone": "UTC"
},
"updatedBy": "cecuser1",
"updatedDate": {
"value": "2021-09-13T19:02:39.947Z",
"timezone": "UTC"
},
"roleName": "manager",
"contentPrivileges": [
{
"typeId": "",
"typeName": null,
"isValid": true,
"operations": [
"view"
]
},
{
"typeId": "EF4C64E6BF81419F9743A8A4348A69EB",
"typeName": "Image",
"isValid": true,
"operations": [
"view",
"update",
"create"
]
}
],
"taxonomyPrivileges": [
{
"taxonomyId": null,
"taxonomyShortName": null,
"isForSiteManagement": false,
"categoryId": "",
"nodes": null,
"isSiteCategory": false,
"isValid": true,
"operations": [
"view"
]
}
],
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/editorialRoles",
"rel": "self",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/editorialRoles",
"rel": "canonical",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
]
}
例2
/content/management/api/v1.1/editorialRoles
これにより、createSite権限を持つタクソノミ・ルールを含むカスタム編集ロールが作成されます。 ペイロードを独自のデータで置換します。
ノート:
任意のタイプ・ルールは空のtypeIdで定義され、任意のカテゴリ・ルールは空のcategoryIdで定義されます。
リクエスト・ペイロード
{
"name": "Site Security Custom Editorial Role",
"description": "role description",
"contentPrivileges": [
{
"typeId": "",
"typeName": "",
"isValid": true,
"operations": [
"view",
"update",
"create",
"delete"
]
}
],
"taxonomyPrivileges": [
{
"taxonomyId": "",
"categoryId": "",
"isValid": true,
"operations": [
"view",
"categorize"
]
},
{
"taxonomyId": "AF6B75DBBCA244FC93166610EA2BA62A",
"categoryId": "F54C934D081B4768B3A93A45C0E6955C",
"isValid": true,
"operations": [
"view",
"categorize",
"createSite"
]
}
]
}
リクエスト・ヘッダー
{
"Content-Type": "application/json",
"X-Requested-With": "XMLHttpRequest"
}
レスポンス本文
{
"id": "0FCCDAB83A6D41819C15B61445F9E686",
"name": "Site Security Custom Editorial Role",
"description": "role description",
"createdBy": "cecuser1",
"createdDate": {
"value": "2023-01-11T02:31:04.992Z",
"timezone": "UTC"
},
"updatedBy": "cecuser1",
"updatedDate": {
"value": "2023-01-11T02:31:04.992Z",
"timezone": "UTC"
},
"roleName": "manager",
"contentPrivileges": [
{
"typeId": "",
"typeName": null,
"typeDisplayName": null,
"isValid": true,
"operations": [
"view",
"update",
"create",
"delete"
]
}
],
"taxonomyPrivileges": [
{
"taxonomyId": null,
"taxonomyShortName": null,
"isForSiteManagement": false,
"categoryId": "",
"nodes": null,
"isSiteCategory": false,
"isValid": true,
"operations": [
"view",
"categorize"
]
},
{
"taxonomyId": "AF6B75DBBCA244FC93166610EA2BA62A",
"taxonomyShortName": "SST",
"isForSiteManagement": true,
"categoryId": "F54C934D081B4768B3A93A45C0E6955C",
"nodes": [
{
"id": "BE58B209A968480480AA2AFBCE9C2D64",
"name": "org1",
"apiName": "sst-o"
},
{
"id": "F54C934D081B4768B3A93A45C0E6955C",
"name": "team1",
"apiName": "sst-o-d"
}
],
"isSiteCategory": false,
"isValid": true,
"operations": [
"view",
"categorize",
"createSite"
]
}
],
"links": [
{
"href": "http://<hostname>/content/management/api/v1.1/editorialRoles",
"rel": "self",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/editorialRoles",
"rel": "canonical",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles",
"rel": "describedby",
"method": "GET",
"mediaType": "application/json"
}
]
}