Schedule Sync

Creates a sync request

Request sync for a content source

Request

URI

POST

https://{vcfa-fqdn}/content/api/sourcecontrol/sync-requests

COPY

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information, please refer to /content/api/about

Request Body

SourceControlSyncRequest of type(s) application/json

Required

{
    "requestId": "string",
    "sourceId": "string",
    "projectId": "string",
    "status": "string",
    "message": "string",
    "createdAt": "string",
    "lastUpdatedAt": "string"
}

string As uuid As uuid

requestId

Read-Only

Request Id

string As uuid As uuid

sourceId

Optional

Content Source Id

string

projectId

Read-Only

Project Id

string

status

Read-Only

Status

Enumeration: REQUESTED, STARTED, PROCESSING, COMPLETED, FAILED, SKIPPED

string

message

Read-Only

Message

string As date-time As date-time

createdAt

Read-Only

Created at

string As date-time As date-time

lastUpdatedAt

Read-Only

Last Updated at

Authentication

This operation uses the following authentication methods.

Authorization

Responses

202

Submitted sync requests

Returns SourceControlSyncRequest of type(s) application/json

{
    "requestId": "string",
    "sourceId": "string",
    "projectId": "string",
    "status": "string",
    "message": "string",
    "createdAt": "string",
    "lastUpdatedAt": "string"
}

string As uuid As uuid

requestId

Read-Only

Request Id

string As uuid As uuid

sourceId

Optional

Content Source Id

string

projectId

Read-Only

Project Id

string

status

Read-Only

Status

Enumeration: REQUESTED, STARTED, PROCESSING, COMPLETED, FAILED, SKIPPED

string

message

Read-Only

Message

string As date-time As date-time

createdAt

Read-Only

Created at

string As date-time As date-time

lastUpdatedAt

Read-Only

Last Updated at

404

source not found

Returns SourceControlSyncRequest of type(s) application/json

"SourceControlSyncRequest Object"

string As uuid As uuid

requestId

Read-Only

Request Id

string As uuid As uuid

sourceId

Optional

Content Source Id

string

projectId

Read-Only

Project Id

string

status

Read-Only

Status

Enumeration: REQUESTED, STARTED, PROCESSING, COMPLETED, FAILED, SKIPPED

string

message

Read-Only

Message

string As date-time As date-time

createdAt

Read-Only

Created at

string As date-time As date-time

lastUpdatedAt

Read-Only

Last Updated at

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/content/api/sourcecontrol/sync-requests

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Source Control Sync Operations

POST

Schedule Sync