機械翻訳について

移動先

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

編集ロールのリスト

get

/content/management/api/v1.1/editorialRoles

カスタム編集ロールをリストします。

リクエスト

問合せパラメータ

• fields(optional): string
  このパラメータは、リスト内の各編集ロールで返されるフィールドを制御するために使用されます。 このパラメータは、フィールド名または「すべて」のカンマ区切りリストを受け入れます。 これらのフィールドは、リスト内の編集ロールごとに返されます。 すべてのフィールド名は大/小文字が区別され、ユーザーは問合せで正しいフィールド名を指定する必要があります。 各編集ロールには、標準フィールド(id、name、description、createdBy、createdDate、updatedBy、updatedDate、roleName)と追加フィールド(contentPrivileges、taxonomyPrivileges)の両方があります。 fieldsを「すべて」 (大/小文字を区別しない)として指定すると、すべての標準フィールドおよび追加フィールドが返されます。 このパラメータは問合せではオプションであり、結果にはレスポンスの標準フィールドのみが表示されます。 問合せで指定されたフィールド名が正しくないか無効な場合は、エラーがスローされます。 このパラメータによって明示的に指定されていない場合でも、「id」フィールドは常に返されます。
  
  例: ?fields=id,name,description
  これにより、編集ロールごとにid、nameおよびdescriptionフィールドが返されます。
  例: ?fields=all
  これにより、すべての標準フィールドと、編集ロールごとにすべての追加フィールドが返されます。
  
• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

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

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

  デフォルト値: name:asc
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。 現在許可されているfieldNamesはnameのみで、現在許可されている演算子はnameのmtのみです。 この問合せパラメータは、デフォルトではオプションです。
  例:
  ?q=(name mt "editor")
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : EditorialRoles

型: object

EditorialRoles

ソースを表示

• 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/EditorialRole"
            }
        },
        "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":"EditorialRoles"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

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

型: array

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

ソースを表示

• Array of: object EditorialRole
  EditorialRole

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

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

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

禁止。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、cURLを使用してGETリクエストを発行して、エディタ・ロールをリストする方法を示しています。

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

例

/content/management/api/v1.1/editorialRoles?limit=10&offset=0&orderBy=name:asc

このリストには、編集ロール名昇順でソートされた、標準フィールドのある10の編集用ロールの最初のセットがリストされます。

レスポンス本文

{
	    "hasMore": false,
	    "offset": 0,
	    "count": 1,
	    "limit": 1,
	    "items": [
	        {
	            "id": "D2434092E77D436D96E468C343249B1D",
	            "name": "Custom Editor Role",
	            "description": "role description",
	            "createdBy": "cecuser1",
	            "createdDate": {
	                "value": "2021-09-13T05:03:55.956Z",
	                "timezone": "UTC"
	            },
	            "updatedBy": "cecuser1",
	            "updatedDate": {
	                "value": "2021-09-13T05:03:55.956Z",
	                "timezone": "UTC"
	            },
	            "roleName": "manager",
	            "links": [
	                {
	                    "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/D2434092E77D436D96E468C343249B1D",
	                    "rel": "self",
	                    "method": "GET",
	                    "mediaType": "application/json"
	                }
	            ]
	        }
	    ],
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0",
	            "rel": "canonical",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles",
	            "rel": "describedby",
	            "method": "GET",
	            "mediaType": "application/schema+json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0",
	            "rel": "first",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles?limit=10&orderBy=name:asc&offset=0",
	            "rel": "last",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }

先頭に戻る