読取り権限操作ステータス
get
/content/management/api/v1.1/permissionOperations/{statusId}
読取り権限操作ステータス。
リクエスト
パス・パラメータ
- statusId: string
権限操作のステータスId。
問合せパラメータ
- links(optional): string
このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK。
ルート・スキーマ : PermissionOperationsStatus
型:
objectPermissionOperationsStatus
ソースを表示
- completed(optional): boolean
元のリクエストが完了しているかどうか
- completedPercentage(optional): integer(int32)
プロセスの完了数を取得し、0から100までの数値。
- endTime(optional): object date
date
- error(optional): object Error
エラー
- id(optional): string
元のリクエストのステータスid。 これはレスポンス取得の必須プロパティです。
- links(optional): array links
ステータス・リソースのリンク
- message(optional): string
現在の処理ステータスに関する人間が読むことができるメッセージ
- progress(optional): string
許容値:
[ "succeeded", "failed", "processing", "pending", "aborted", "paused", "blocked" ]元のリクエストの現在の進行状況。 これはレスポンス取得の必須プロパティです。 - requestStatus(optional): integer(int32)
元のリクエストのHTTPステータス・コード。 これはポーリング・リクエストのステータスではありません。 値はリクエストが完了した後にのみ使用できます
- result(optional): object ResultPermissionOperations
結果
- startTime(optional): object date
date
ネストされたスキーマ: Error
型:
objectエラー
ソースを表示
- detail(optional): string
詳細なエラー・メッセージ
- instance(optional): string
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション固有のエラー・コード。
- o:errorDetails(optional): object Error
エラー
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONのパス
- status(optional): integer(int32)
HTTPステータス・コード。
- title(optional): string
要約エラー・メッセージ。 これはレスポンス取得の必須プロパティです。
- type(optional): string
HTTPエラー・コード・ページにリンクします。 これはレスポンス取得の必須プロパティです。
ネストされたスキーマ : ResultPermissionOperations
型:
object結果
ソースを表示
- body(optional): object PermissionOperations
権限操作
- headers(optional): array headers
元の非同期リクエストへのレスポンスのHTTPヘッダーのリスト
- status(optional): object ResultHTTPStatus
ResultHTTPStatus
ネストされたスキーマ: Link
型:
objectリソースのリンク。
ソースを表示
- href(optional): string
ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
- mediaType(optional): string
メディア・タイプ。
- method(optional): string
ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
- profile(optional): string
ターゲット・リソースを記述するメタデータにリンクします。
- rel(optional): string
関連タイプ これはレスポンス取得の必須プロパティです。
- templated(optional): boolean
URIがテンプレートであるかどうか。
ネストされたスキーマ : PermissionOperations
型:
object権限操作
ソースを表示
- links(optional): array links
権限操作リソースのリンク。
- operations(optional): object PermissionOperationsActions
実行可能な操作。 現時点では、一度に1つの操作のみがサポートされています。
ネストされたスキーマ: headers
型:
array元の非同期リクエストへのレスポンスのHTTPヘッダーのリスト
ソースを表示
- Array of: object ResultHTTPHeader
ResultHTTPHeader
ネストされたスキーマ : ResultHTTPStatus
型:
objectResultHTTPStatus
ソースを表示
- code(optional): integer(int32)
HTTPレスポンス・ステータス・コード
- reason(optional): string
HTTPレスポンス理由フレーズ
ネストされたスキーマ : ResourceId
型:
objectResourceId
ソースを表示
- id(optional): string
リソースのId。
- name(optional): string
リソースの名前
- type(optional): string
許容値:
[ "repository", "collection", "channel", "type", "workflow", "scheduledjob", "translationjob", "editorialrole", "publishingrole", "siteplan", "taxonomy", "retentionpolicy", "hold" ]リソースのタイプ。
ネストされたスキーマ : FailedUserId
型:
objectFailedUserId
ソースを表示
- groupType(optional): string
許容値:
[ "CEC", "IDP" ] - message(optional): string
失敗メッセージです。
- name(optional): string
- type(optional): string
許容値:
[ "user", "group" ]
ネストされたスキーマ : UserId
型:
objectUserId
ソースを表示
- groupType(optional): string
許容値:
[ "CEC", "IDP" ] - name(optional): string
- type(optional): string
許容値:
[ "user", "group" ]
ネストされたスキーマ : ResultHTTPHeader
型:
objectResultHTTPHeader
ソースを表示
- name(optional): string
HTTPレスポンス・ヘッダー名
- value(optional): string
HTTPレスポンス・ヘッダー値
304 レスポンス
変更されていません。
400レスポンス
不正リクエスト
403レスポンス
禁止。
404レスポンス
見つかりません。
500レスポンス
内部サーバー・エラー
例
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、権限操作のステータスを読み取る方法を示しています。
curl -X GET 'content-type: application/json' 'https://host:port/content/management/api/v1.1/permissionOperations/{statusId}'
例1:
これは、操作IDを持つ成功した権限非同期共有操作のステータスを読み取ります: OP4C2BA99B626B4E43A4A64853D639F4CA。
/content/management/api/v1.1/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA
レスポンス本文
{
"id": "OP4C2BA99B626B4E43A4A64853D639F4CA",
"startTime": {
"value": "2018-12-21T06:47:14.656Z",
"timezone": "UTC"
},
"endTime": {
"value": "2018-12-21T06:47:16.759Z",
"timezone": "UTC"
},
"progress": "succeeded",
"completed": true,
"message": "Job Completed Successfully",
"completedPercentage": 100,
"result": {
"status": {
"code": 200,
"reason": ""
},
"headers": [],
"body": {
"operations": {
"share": {
"resource" : {
"id" : "F0A4079D50E370E0B074F62AE4863ECDF2B8EF156CC7",
"type" : "repository"
},
"roles": [
{
"name" : "viewer",
"message" : "message1",
"users" : [
{"id" : "cecuserLoginIdName", "type" : "user"}
]
},
{
"name" : "manager",
"message" : "message2",
"users" : [
{"id" : "cecgroupLoginIdName", "type" : "group"}
]
}
],
"successRoles": [
{
"name" : "viewer",
"users" : [
{"id" : "cecuserLoginIdName", "type" : "user"}
]
},
{
"name" : "manager",
"users" : [
{"id" : "cecgroupLoginIdName", "type" : "group"}
]
}
]
}
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
"rel": "self",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
"rel": "canonical",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
]
}
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations/OP4C2BA99B626B4E43A4A64853D639F4CA",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
例2:
これは、操作IDを持つ成功したアイテムのpermissionOperations共有解除操作のステータスを読み取ります: E2A8C607848940D9ADA0DFFBE078E793。
/content/management/api/v1.1/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793
リクエスト本文
{
"id": "E2A8C607848940D9ADA0DFFBE078E793",
"startTime": {
"value": "2018-12-21T06:47:14.656Z",
"timezone": "UTC"
},
"endTime": {
"value": "2018-12-21T06:47:16.759Z",
"timezone": "UTC"
},
"progress": "succeeded",
"completed": true,
"message": "Job Completed Successfully",
"completedPercentage": 100,
"result": {
"status": {
"code": 200,
"reason": ""
},
"headers": [],
"body": {
"operations": {
"unshare": {
"resource": {
"id": "F0A4079D50E370E0B074F62AE4863ECDF2B8EF156CC7",
"type": "repository"
},
"message": "hi",
"users": [
{
"id": "cecuserLoginIdName",
"type": "user"
}
],
"successUsers": [
{
"id": "cecuserLoginIdName",
"type": "user"
}
]
}
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
"rel": "self",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations",
"rel": "canonical",
"method": "POST",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
]
}
},
"links": [
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793",
"rel": "self",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793",
"rel": "canonical",
"method": "GET",
"mediaType": "application/json"
},
{
"href": "https://<hostname>/content/management/api/v1.1/metadata-catalog/permissionOperations/E2A8C607848940D9ADA0DFFBE078E793",
"rel": "describedby",
"method": "GET",
"mediaType": "application/schema+json"
}
]
}