Sync Policy

Sync Policy

This request assigns the default policy to all organizations that do not have an assigned policy.

The result of this API call is a task which must be polled by using the respective APIs for task polling. If the task succeeds, then the result can be obtained from the result field. If the task fails, there is no result. The failure reason is in the error field.

Request
URI
POST
https://{api_host}/policies/sync
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns C4ApiTask_of_object of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "endTime": 1499929558827,
    "error": {
        "args": [],
        "code": "Forbidden",
        "msg": "Permission denied.",
        "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
    },
    "id": "f61d60d2-698a-46dc-a266-88df27644956",
    "lastUpdated": 1499929558827,
    "progress": 100,
    "resultType": "string",
    "site": "site2",
    "startTime": 1499929548951,
    "state": "string",
    "user": "root",
    "warnings": [],
    "workflowInfo": {}
}
integer As int64 As int64
endTime
Optional

Timestamp in msec of the completion time of the task. -1 indicates that the task did not complete yet.

ApiError
error
Optional

error

string As uuid As uuid
id
Optional

The unique identifier of the long-running task. It is unique and can be used for monitoring.

integer As int64 As int64
lastUpdated
Optional

Timestamp in msec of the last task status update.

integer As int32 As int32
progress
Optional

Percentage-based progress of the task.

object
result
Optional

The result of the task. Populates only when the execution succeeds.

string
resultType
Optional

Indicates the type of the task result. Populates only when the execution succeeds.

string
site
Optional

Site on which the task runs.

integer As int64 As int64
startTime
Optional

Timestamp in msec of the creation time of the task.

Task_State
state
Optional

state

string
user
Optional

The user who started the task.

array of ResultWarning
warnings
Optional

Warnings, which occurred during the task execution.

ApiWorkflowInfo
workflowInfo
Optional

workflowInfo


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Policies Operations
PATCH
Assign Policy To Org
POST
Clone Policy
POST
Create Policy
DELETE
Delete Policy
GET
Policies
GET
Policy
GET
Policy Status
POST
Sync Policy
PUT
Update Policy