Create Sync Configuration - Schedules

Schedules

Download API definition:

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

Create Sync Configuration

post https://dev-api.bentley.com/schedules/{scheduleId}/sync-configuration

Creates a Sync Configuration for a Schedule.

Sync Configuration

Creates a Sync Configuration that links a v6.5 Schedule with a v10 Schedule for synchronization purposes.

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.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Sync Configuration Create Request

v10ScheduleId

String

The unique identifier of the v10 Schedule.

Example

json

{
    "v10ScheduleId": "4c001b1a-0081-4b6c-be69-07b7009fcf15"
}

Response 201 Created

Created

json

{
    "syncConfiguration": {
        "isEnabled": true,
        "v10ScheduleId": "4c001b1a-0081-4b6c-be69-07b7009fcf15",
        "v65ScheduleId": "e9619567-54ac-45b2-9c2f-d567b761c555"
    }
}

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": "InvalidProperty",
            "message": "The v10 Schedule iModel does not match the v6.5 Schedule iModel.",
            "target": "v10ScheduleId"
        }],
        "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 409 Conflict

Indicates that the entity being created conflicts with an existing one.

json

{
    "error": {
        "code": "ConfigurationExists",
        "message": "Configuration with provided v6.5 Schedule id already exists."
    }
}

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

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
}

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 Configuration

Representation of a Sync Configuration.

isEnabled

Boolean, null

Is the Sync Configuration enabled.

v10ScheduleId

String

The unique identifier of the v10 Schedule.

v65ScheduleId

String

The unique identifier of the v6.5 Schedule.

json

{
    "type": "object",
    "title": "Sync Configuration",
    "properties": {
        "isEnabled": {
            "type": "boolean",
            "nullable": true,
            "description": "Is the Sync Configuration enabled."
        },
        "v10ScheduleId": {
            "type": "string",
            "description": "The unique identifier of the v10 Schedule."
        },
        "v65ScheduleId": {
            "type": "string",
            "description": "The unique identifier of the v6.5 Schedule."
        }
    },
    "description": "Representation of a Sync Configuration.",
    "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 Configuration Response

Container for Sync Configuration object.

syncConfiguration

SyncConfiguration

json

{
    "type": "object",
    "title": "Sync Configuration Response",
    "properties": {
        "syncConfiguration": {
            "$ref": "#/components/schemas/SyncConfiguration"
        }
    },
    "description": "Container for Sync Configuration object.",
    "additionalProperties": false
}

Sync Configuration Create Request

Properties of the Sync Configuration to be created.

v10ScheduleId

String

The unique identifier of the v10 Schedule.

json

{
    "type": "object",
    "title": "Sync Configuration Create Request",
    "properties": {
        "v10ScheduleId": {
            "type": "string",
            "description": "The unique identifier of the v10 Schedule."
        }
    },
    "description": "Properties of the Sync Configuration to be created.",
    "additionalProperties": false
}

Was this page helpful?

Sync Configuration

Authentication

Rate limits

Request

Request parameters

Request headers

Request body

Sync Configuration Create Request

Example

Response

Response 201 Created

Response 400 Bad Request

Response 401 Unauthorized

Response 404 Not Found

Response 409 Conflict

Response 429 Too many requests

Response headers

Definitions

Error

DetailedError

Error Response

Sync Configuration

Detailed Error Response

Sync Configuration Response

Sync Configuration Create Request