Table of contents
Schedules
This API is a Technical Preview and is available for testing purposes only. Do not use in production.
GET https://dev-api.bentley.com/schedules/{scheduleId}/sync-operations/{syncOperationId}/logs[?logLevel][&associatedStep][&$top][&$continuationToken]

Gets the logs of a Sync Operation.

Sync Operation Logs

Sync Operation logs show relevant events/logs of a specific Sync Operation that helps to identify operation details.

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

Name
Required?
Description
syncOperationId
Yes

The unique identifier of the Synchronization Operation.

scheduleId
Yes

The unique identifier of the Schedule.

logLevel
No

Comma separated log levels.

associatedStep
No

Comma separated Synchronization Step States.

$top
No

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
No

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

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "logs": [{
        "id": "0dcfe7ae-603f-40b4-b2a6-b6c85dd389c5",
        "syncOperationId": "484b29c0-3851-4e23-9191-cebca075b57b",
        "code": "v10ScheduleOverridden",
        "description": "Due to a conflict or a server error, v10 schedule data was overridden.",
        "logLevel": "Warning",
        "associatedStep": "SyncToV10Schedule"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/sync-operations/484b29c0-3851-4e23-9191-cebca075b57b/logs?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/sync-operations/484b29c0-3851-4e23-9191-cebca075b57b/logs?$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"
        }, {
            "code": "InvalidParameter",
            "message": "Provided value should be of type 'Bentley.Synchro.SchedulesContract.Models.LogLevel', but is not.",
            "target": "logLevel"
        }, {
            "code": "InvalidParameter",
            "message": "Provided value should be of type 'Bentley.Synchro.SchedulesContract.Models.SynchronizationStepStateType', but is not.",
            "target": "associatedStep"
        }],
        "message": "The request contains invalid properties."
    }
}

Response 401 Unauthorized

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 or synchronization operation 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

Name
Description
retry-after

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

Link

Hyperlink container.

Name
Type
Description
href
String

Hyperlink to the specific entity.

Error

Contains error information.

Name
Type
Description
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.

Log Level

Describes what type of log level was sent.

Name
Type
Description
Information
String
Warning
String
Error
String

Paging Links

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

Name
Type
Description
next
self

DetailedError

Contains error information and an array of more specific errors.

Name
Type
Description
code
String

One of a server-defined set of error codes.

target
String, null

The target of the error.

details

Optional array of more specific errors.

message
String

A human-readable representation of the error.

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.

Name
Type
Description
error

Error information.

Sync Operation Log

Representation of a Sync Operation Log.

Name
Type
Description
id
String

The unique identifier of the log.

code
String, null

Identifier for the failure type.

logLevel
All of: LogLevel

Value specifying log level.

description
String

Description for clarifying the synchronization operation log context.

associatedStep

Identifier for specifying which step created the log.

syncOperationId
String

The unique identifier of the synchronization operation.

Detailed 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.

Name
Type
Description
error

Error Detailed information.

Sync Operation Logs Response

A list of sepcified Sync Operation logs.

Name
Type
Description
logs

A list of Sync Operation logs.

Synchronization Step State Type

This value determines the type of Synchronization Step possible in the Sync Operation Log.

Name
Type
Description
SyncFromIModel
String
SyncFromV10Schedule
String
SyncToIModel
String
SyncToV10Schedule
String
OdbcExport
String

Was this page helpful?