Get Sync Operations - Schedules

Schedules

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Get Sync Operations

get https://dev-api.bentley.com/schedules/{scheduleId}/sync-operations[?$top][&$continuationToken]

Gets the Sync Operations of a Schedule.

Sync Operation

Sync Operations show the state of all synchronizations between configured schedules.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

$top

The $top system query option requests the number of items in the queried collection to be included in the result. When $top parameter is not provided default is set to 100. $top value cannot exceed 10000.

$continuationToken

A token used for pagination to retrieve the next set of results. It indicates where the previous page of results ended, allowing you to fetch the subsequent batch of data.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response 200 OK

json

{
    "syncOperations": [{
        "completionTime": null,
        "createdAt": "2019-11-15T03:10:00Z",
        "failureDescription": null,
        "id": "765c980f-6ccb-4136-956e-424b097b8678",
        "state": "Queued",
        "synchronizationStepStates": {
            "odbcExport": {
                "state": "Queued"
            },
            "syncToV10Schedule": {
                "state": "Queued"
            },
            "syncFromIModel": {
                "state": "Queued"
            },
            "syncToIModel": {
                "state": "Queued"
            }
        }
    }, {
        "completionTime": "2019-11-15T02:22:00Z",
        "createdAt": "2019-11-15T02:20:00Z",
        "failureDescription": null,
        "id": "c19d0039-79dd-48dc-8960-997aad55cc92",
        "state": "Succeeded",
        "synchronizationStepStates": {
            "odbcExport": {
                "state": "Completed"
            },
            "syncToV10Schedule": {
                "state": "Completed"
            },
            "syncFromIModel": {
                "state": "Completed"
            },
            "syncToIModel": {
                "state": "Completed"
            }
        }
    }, {
        "completionTime": "2019-11-15T01:16:00Z",
        "createdAt": "2019-11-15T01:15:00Z",
        "failureDescription": "An error occurred whilst processing your request.",
        "id": "2545a028-32f3-46c2-95c3-d43a70b96dc1",
        "state": "Failed",
        "synchronizationStepStates": {
            "odbcExport": {
                "state": "Failed"
            },
            "syncToV10Schedule": {
                "state": "Failed"
            },
            "syncFromIModel": {
                "state": "Failed"
            },
            "syncToIModel": {
                "state": "Failed"
            }
        }
    }, {
        "completionTime": "2019-11-15T00:12:00Z",
        "createdAt": "2019-11-15T00:00:00Z",
        "failureDescription": "An partial error occurred whilst processing your request.",
        "id": "0dcfe7ae-603f-40b4-b2a6-b6c85dd389c5",
        "state": "PartialSuccess",
        "synchronizationStepStates": {
            "odbcExport": {
                "state": "Failed"
            },
            "syncToV10Schedule": {
                "state": "Completed"
            },
            "syncFromIModel": {
                "state": "Completed"
            },
            "syncToIModel": {
                "state": "Completed"
            }
        }
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/sync-operations?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/sync-operations?$top=2&$continuationToken=eyJQcmltYXJ5U2tpcFRva2VuIjoiMDAwNGE5MDAtM2UxYy00NGNlLThhMzktYWUxZWRlY2M1MWY0IiwiU2Vjb25kYXJ5U2tpcFRva2VuIjpudWxsfQ=="
        }
    }
}

Response 400 Bad Request

The 400 (Bad Request) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

{
    "error": {
        "code": "InvalidSchedulesRequest",
        "details": [{
            "code": "InvalidValue",
            "message": "Top value is not positive, or exceeds maximum page size.",
            "target": "$top"
        }, {
            "code": "InvalidValue",
            "message": "Provided continuation token is invalid.",
            "target": "$continuationToken"
        }],
        "message": "The request contains invalid properties."
    }
}

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 404 Not Found

This response indicates that the provided Schedule is not available.

json

{
    "error": {
        "code": "ScheduleNotFound",
        "message": "Requested Schedule is not available.",
        "target": "scheduleId"
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "description": "Hyperlink container.",
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

Paging Links

URLs for redoing the current request and/or getting the next page of results if applicable.

Link

self

Link

json

{
    "type": "object",
    "title": "Paging Links",
    "properties": {
        "next": {
            "$ref": "#/components/schemas/Link"
        },
        "self": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable.",
    "additionalProperties": false
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "additionalProperties": true
}

Error Response

Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "additionalProperties": false
}

Sync Operation state

The state of the operation.

Queued

String

InProgress

String

Succeeded

String

Failed

String

PartialSuccess

String

Unknown

String

json

{
    "enum": [
        "Queued",
        "InProgress",
        "Succeeded",
        "Failed",
        "PartialSuccess",
        "Unknown"
    ],
    "type": "string",
    "description": "The state of the operation.",
    "title": "Sync Operation state"
}

Sync Operation

Representation of a Sync Operation.

String

The unique identifier of the operation.

Sync Operation state

SyncOperation-state

The state of the operation.

createdAt

Date-time, null

Timestamp when the operation was requested.

completionTime

Date-time, null

Timestamp when the operation completed.

failureDescription

String, null

Description for why the operation failed or partially succeeded.

synchronizationStepStates

SynchronizationStepStates

A list of states for each synchronization step of the operation.

json

{
    "type": "object",
    "title": "Sync Operation",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the operation."
        },
        "state": {
            "enum": [
                "Queued",
                "InProgress",
                "Succeeded",
                "Failed",
                "PartialSuccess",
                "Unknown"
            ],
            "type": "string",
            "description": "The state of the operation.",
            "title": "Sync Operation state",
            "$ref": "#/components/schemas/SyncOperation-state"
        },
        "createdAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Timestamp when the operation was requested."
        },
        "completionTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Timestamp when the operation completed."
        },
        "failureDescription": {
            "type": "string",
            "nullable": true,
            "description": "Description for why the operation failed or partially succeeded."
        },
        "synchronizationStepStates": {
            "$ref": "#/components/schemas/SynchronizationStepStates",
            "description": "A list of states for each synchronization step of the operation."
        }
    },
    "description": "Representation of a Sync Operation.",
    "additionalProperties": false
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError",
            "description": "Error Detailed information."
        }
    },
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "additionalProperties": false
}

Sync Operations Response

List of Sync Operations.

_links

PagingLinks

syncOperations

SyncOperation[]

A list of Sync Operations.

json

{
    "type": "object",
    "title": "Sync Operations Response",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/PagingLinks"
        },
        "syncOperations": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/SyncOperation"
            },
            "description": "A list of Sync Operations."
        }
    },
    "description": "List of Sync Operations.",
    "additionalProperties": false
}

Synchronization Step States

Representation of the states of the synchronization steps within an Integrations Operation.

odbcExport

SynchronizationStepStateValue

The state of the odbcExport synchronization step.

syncToIModel

SynchronizationStepStateValue

The state of the syncToIModel synchronization step.

syncFromIModel

SynchronizationStepStateValue

The state of the syncFromIModel synchronization step.

syncToV10Schedule

SynchronizationStepStateValue

The state of the syncToV10Schedule synchronization step.

json

{
    "type": "object",
    "title": "Synchronization Step States",
    "properties": {
        "odbcExport": {
            "$ref": "#/components/schemas/SynchronizationStepStateValue",
            "description": "The state of the odbcExport synchronization step."
        },
        "syncToIModel": {
            "$ref": "#/components/schemas/SynchronizationStepStateValue",
            "description": "The state of the syncToIModel synchronization step."
        },
        "syncFromIModel": {
            "$ref": "#/components/schemas/SynchronizationStepStateValue",
            "description": "The state of the syncFromIModel synchronization step."
        },
        "syncToV10Schedule": {
            "$ref": "#/components/schemas/SynchronizationStepStateValue",
            "description": "The state of the syncToV10Schedule synchronization step."
        }
    },
    "description": "Representation of the states of the synchronization steps within an Integrations Operation.",
    "additionalProperties": false
}

Synchronization Step State Value state

The state of the synchronization step.

Queued

String

InProgress

String

Completed

String

Failed

String

Unknown

String

json

{
    "enum": [
        "Queued",
        "InProgress",
        "Completed",
        "Failed",
        "Unknown"
    ],
    "type": "string",
    "description": "The state of the synchronization step.",
    "title": "Synchronization Step State Value state"
}

Synchronization Step State Value

Representation of the state of a single synchronization step.

Synchronization Step State Value state

SynchronizationStepStateValue-state

The state of the synchronization step.

json

{
    "type": "object",
    "title": "Synchronization Step State Value",
    "properties": {
        "state": {
            "enum": [
                "Queued",
                "InProgress",
                "Completed",
                "Failed",
                "Unknown"
            ],
            "type": "string",
            "description": "The state of the synchronization step.",
            "title": "Synchronization Step State Value state",
            "$ref": "#/components/schemas/SynchronizationStepStateValue-state"
        }
    },
    "description": "Representation of the state of a single synchronization step.",
    "additionalProperties": false
}

Was this page helpful?