Synchronize Uploaded Microsoft Project File - Schedules

Schedules

Download API definition:

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

Synchronize Uploaded Microsoft Project File

POST https://dev-api.bentley.com/schedules/{scheduleId}/imports/microsoft-project/synchronize

This endpoint is used to synchronize a file into the schedule that has already been uploaded using the files endpoints.

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.

Entity to post for Microsoft project synchronization.

Microsoft Project Synchronization Request

fileId

String

Unique identifier of the File.

filePath

String

Path of the File.

options

MicrosoftProjectSynchronizationOptions

Synchronization options.

synchronizerId

String

Unique identifier of the Synchronizer to use.

Example

json

{
    "fileId": "ac241ce2-749b-4774-bf67-586c3c16a7be",
    "filePath": "/required/custom/path",
    "options": {
        "syncActivityCodeAssignments": "Synchronize",
        "syncActivityCodes": "Synchronize",
        "syncCalendars": "Synchronize",
        "syncCosts": "Synchronize",
        "syncLinks": "Synchronize",
        "syncResourceAssignments": "Synchronize",
        "syncResourceCodeAssignments": "Synchronize",
        "syncResourceCodes": "Synchronize",
        "syncResources": "Synchronize",
        "syncTaskConstraints": "Synchronize",
        "syncTasks": "Synchronize",
        "syncUserFieldValues": "Synchronize",
        "syncUserFields": "Synchronize"
    },
    "synchronizerId": "534dd02a-2a5c-48c9-bf5a-cc8e77a59523"
}

Response 202 Accepted

This response indicates that the requested long-running operation was Accepted.

json

{
    "operation": {
        "id": "1604789f-68c4-46ba-b20d-8a19f8319362"
    },
    "synchronizer": {
        "id": "ae73d684-2878-424e-bab2-025eafbf766b"
    },
    "_links": {
        "operationLocation": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/operations/1604789f-68c4-46ba-b20d-8a19f8319362"
        }
    }
}

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": "Provided 'fileId' value is not valid. Requested File is not available.",
            "target": "fileId"
        }],
        "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 403 Forbidden

User is not authorized to synchronize a file.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

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 415 Unsupported Media Type

This response indicates that the provided file is not supported.

json

{
    "error": {
        "code": "UnsupportedMediaType",
        "message": "Media Type is not supported."
    }
}

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

Synchronizer Create Response

Contains properties of the created long-running operation, and a link to this operation.

operation

OperationCreateResponseProperties, null

Contains properties of the created long-running operation.

synchronizer

SynchronizerCreateResponseProperties

Properties of the Synchronizer to be created.

_links

OperationLocationLink, null

Contains the hyperlink to the Operations endpoint to check the operation information.

json

{
    "title": "Synchronizer Create Response",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation.",
            "nullable": true
        },
        "synchronizer": {
            "$ref": "#/components/schemas/SynchronizerCreateResponseProperties",
            "description": "Properties of the Synchronizer to be created."
        },
        "_links": {
            "$ref": "#/components/schemas/OperationLocationLink",
            "description": "Contains the hyperlink to the Operations endpoint to check the operation information.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the created long-running operation, and a link to this operation.",
    "x-codegen-extends-class": "OperationCreateResponse"
}

Synchronizer Create Response Properties

Contains properties of the Synchronizer that is queued for creation.

String

The unique identifier of the Synchronizer.

json

{
    "title": "Synchronizer Create Response Properties",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Synchronizer."
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the Synchronizer that is queued for creation."
}

Synchronization Option

The option on how to synchronize data. See the Synchronization Options section for details.

Synchronize

String

Consolidate

String

Integrate

String

Skip

String

Unknown

String

json

{
    "title": "Synchronization Option",
    "enum": [
        "Synchronize",
        "Consolidate",
        "Integrate",
        "Skip",
        "Unknown"
    ],
    "type": "string",
    "description": "The option on how to synchronize data. See the [Synchronization Options](#synchronizationoptions) section for details."
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

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

Microsoft Project Synchronization Options

Import options for Microsoft Project files.

syncActivityCodeAssignments

SynchronizationOption, null

Synchronization option, specifying how Activity Code Assignments should be synced.

syncActivityCodes

SynchronizationOption, null

Synchronization option, specifying how Activity Codes should be synced.

syncCalendars

SynchronizationOption, null

Synchronization option, specifying how Calendars should be synced.

syncCosts

SynchronizationOption, null

Synchronization option, specifying how Costs should be synchronized.

syncLinks

SynchronizationOption, null

Synchronization option, specifying how Links should be synced.

syncResourceAssignments

SynchronizationOption, null

Synchronization option, specifying how Resource Assignments should be synced.

syncResourceCodeAssignments

SynchronizationOption, null

Synchronization option, specifying how Resource Code Assignments should be synced.

syncResourceCodes

SynchronizationOption, null

Synchronization option, specifying how Resource Codes should be synced.

syncResources

SynchronizationOption, null

Synchronization option, specifying how Resources should be synced.

syncTaskConstraints

SynchronizationOption, null

Synchronization option, specifying how Task Constraints should be synced.

syncTasks

SynchronizationOption, null

Synchronization option, specifying how Tasks should be synced.

syncUserFieldValues

SynchronizationOption, null

Synchronization option, specifying how User Field Values should be synced.

syncUserFields

SynchronizationOption, null

Synchronization option, specifying how User Fields should be synced.

json

{
    "title": "Microsoft Project Synchronization Options",
    "type": "object",
    "properties": {
        "syncActivityCodeAssignments": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Activity Code Assignments should be synced.",
            "nullable": true
        },
        "syncActivityCodes": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Activity Codes should be synced.",
            "nullable": true
        },
        "syncCalendars": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Calendars should be synced.",
            "nullable": true
        },
        "syncCosts": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Costs should be synchronized.",
            "nullable": true
        },
        "syncLinks": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Links should be synced.",
            "nullable": true
        },
        "syncResourceAssignments": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Resource Assignments should be synced.",
            "nullable": true
        },
        "syncResourceCodeAssignments": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Resource Code Assignments should be synced.",
            "nullable": true
        },
        "syncResourceCodes": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Resource Codes should be synced.",
            "nullable": true
        },
        "syncResources": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Resources should be synced.",
            "nullable": true
        },
        "syncTaskConstraints": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Task Constraints should be synced.",
            "nullable": true
        },
        "syncTasks": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how Tasks should be synced.",
            "nullable": true
        },
        "syncUserFieldValues": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how User Field Values should be synced.",
            "nullable": true
        },
        "syncUserFields": {
            "$ref": "#/components/schemas/SynchronizationOption",
            "description": "Synchronization option, specifying how User Fields should be synced.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Import options for Microsoft Project files."
}

Microsoft Project Synchronization Request

Properties used in Microsoft Project synchronization.

fileId

String

Unique identifier of the File.

filePath

String

Path of the File.

options

MicrosoftProjectSynchronizationOptions

Synchronization options.

synchronizerId

String

Unique identifier of the Synchronizer to use.

json

{
    "title": "Microsoft Project Synchronization Request",
    "type": "object",
    "properties": {
        "fileId": {
            "type": "string",
            "description": "Unique identifier of the File."
        },
        "filePath": {
            "type": "string",
            "description": "Path of the File."
        },
        "options": {
            "$ref": "#/components/schemas/MicrosoftProjectSynchronizationOptions",
            "description": "Synchronization options."
        },
        "synchronizerId": {
            "type": "string",
            "description": "Unique identifier of the Synchronizer to use."
        }
    },
    "additionalProperties": false,
    "description": "Properties used in Microsoft Project synchronization."
}

Operation Create Response Properties

Contains the id of the created long-running operation.

String, null

The unique identifier of the Operation.

json

{
    "title": "Operation Create Response Properties",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Operation.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Contains the id of the created long-running operation."
}

Operation Location

Contains the URL to the Operations endpoint to check the information about a long-running operation.

operationLocation

Link

URL to the Operations endpoint with pre-entered Operation ID.

json

{
    "title": "Operation Location",
    "type": "object",
    "properties": {
        "operationLocation": {
            "$ref": "#/components/schemas/Link",
            "description": "URL to the Operations endpoint with pre-entered Operation ID."
        }
    },
    "additionalProperties": false,
    "description": "Contains the URL to the Operations endpoint to check the information about a long-running operation."
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

json

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

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.

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "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.",
    "properties": {
        "error": {
            "description": "Error Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

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

Error Response

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?

Request

Request parameters

Request headers

Request body

Microsoft Project Synchronization Request

Example

Response

Response 202 Accepted

Response 400 Bad Request

Response 401 Unauthorized

Response 403 Forbidden

Response 404 Not Found

Response 415 Unsupported Media Type

Response 429 Too many requests

Response headers

Definitions

Synchronizer Create Response

Synchronizer Create Response Properties

Synchronization Option

Link

Microsoft Project Synchronization Options

Microsoft Project Synchronization Request

Operation Create Response Properties

Operation Location

DetailedError

Detailed Error Response

Error

Error Response