Get Sync Request

Get a sync request by id

Request

URI

GET

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

COPY

Path Parameters

string

Required

ID of the sync request

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

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Sync request for id

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

request not found

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

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/content/api/sourcecontrol/sync-requests/{id}

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Source Control Sync Operations