Get Microsoft Project Synchronizer - Schedules

Schedules

Download API definition:

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}/imports/microsoft-project/synchronizers/{synchronizerId}

Gets the Microsoft Project Import Synchronizer.

V10 Endpoint

This endpoint is only supported by v10 schedules. The schedule type can be identified by querying the /schedules/{scheduleId} endpoint.

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.

synchronizerId

Yes

The unique identifier of Microsoft Project Synchronizer.

Request headers

If-None-Match

A header that makes the request conditional. If the ETag of the requested resource or resource collection matches the provided value, a 304 (Not Modified) response is returned. For more information see the official documentation.

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

{
    "synchronizer": {
        "deleted": false,
        "id": "c4e997a4-83e0-485b-b59c-13f210683f23",
        "originalProjectName": "Roads",
        "originalProjectPath": "C:\\documents\\roads",
        "originalSynchronizationTime": "2019-12-03T12:00:00.0000000+00:00",
        "originalSynchronizationType": "Import",
        "projectName": "Roads",
        "projectPath": "C:\\documents\\roads",
        "synchronizationDetails": {
            "created": {
                "calendars": 1,
                "resources": 4,
                "tasks": 11
            },
            "deleted": {
                "resources": 2,
                "tasks": 4
            },
            "updated": {
                "resources": 1,
                "tasks": 6
            },
            "warnings": [{
                "message": "Warning: Resource (UID=R2) was assigned to task (UID=T4) more than once, assignment (UID=A3) was ignored."
            }, {
                "message": "Warning: Resource (UID=R4) was assigned to task (UID=T11) more than once, assignment (UID=A6) was ignored."
            }]
        },
        "synchronizationTime": "2019-12-03T12:00:00.0000000+00:00",
        "synchronizationType": "Import",
        "synchronizerName": "Roads"
    }
}

Response headers

ETag

A header that identifies a specific version of a resource or resource collection. For more information see the official documentation.

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 Synchronizer or 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

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
}

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
}

Synchronization Type

Synchronization Type specifies if it was an import, export or synchronization.

Import

String

Export

String

SynchronizeFrom

String

SynchronizeTo

String

Unknown

String

json

{
    "enum": [
        "Import",
        "Export",
        "SynchronizeFrom",
        "SynchronizeTo",
        "Unknown"
    ],
    "type": "string",
    "title": "Synchronization Type",
    "description": "Synchronization Type specifies if it was an import, export or synchronization."
}

Synchronizer Logs Message

Synchronizer Logs Message.

message

String

Log message of a Synchronizer Logs Message.

json

{
    "type": "object",
    "title": "Synchronizer Logs Message",
    "properties": {
        "message": {
            "type": "string",
            "description": "Log message of a Synchronizer Logs Message."
        }
    },
    "description": "Synchronizer Logs Message.",
    "additionalProperties": false
}

Synchronizer Write Logs Model

Synchronizer modification counts.

links

Integer, null

The amount of Links modified.

risks

Integer, null

The amount of Risks modified.

tasks

Integer, null

The amount of Tasks modified.

calendars

Integer, null

The amount of Calenders modified.

companies

Integer, null

The amount of Companies modified.

costCodes

Integer, null

The amount of Cost Codes modified.

resources

Integer, null

The amount of Resources modified.

taskCosts

Integer, null

The amount of Task Costs modified.

userFields

Integer, null

The mount of User Fields modified.

activityCodes

Integer, null

The amount of Activity Codes modified.

resourceCodes

Integer, null

The amount of Resource Codes modified.

resourceRates

Integer, null

The amount of Resource Rates modified.

taskCategories

Integer, null

The amount of Task Categories modified.

userFieldValues

Integer, null

The mount of User Field Values modified.

activityCodeValues

Integer, null

The amount of Activity Code Values modified.

resourceCodeValues

Integer, null

The amount of Resource Code Values modified.

resourceAssignments

Integer, null

The amount of Resource Assignments modified.

activityCodeValuesAssignments

Integer, null

The mount of Activity Code Values Assignments modified.

resourceCodeValuesAssignments

Integer, null

The amount of Resource Code Values Assignments modified.

json

{
    "type": "object",
    "title": "Synchronizer Write Logs Model",
    "properties": {
        "links": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Links modified."
        },
        "risks": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Risks modified."
        },
        "tasks": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Tasks modified."
        },
        "calendars": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Calenders modified."
        },
        "companies": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Companies modified."
        },
        "costCodes": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Cost Codes modified."
        },
        "resources": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Resources modified."
        },
        "taskCosts": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Task Costs modified."
        },
        "userFields": {
            "type": "integer",
            "nullable": true,
            "description": "The mount of User Fields modified."
        },
        "activityCodes": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Activity Codes modified."
        },
        "resourceCodes": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Resource Codes modified."
        },
        "resourceRates": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Resource Rates modified."
        },
        "taskCategories": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Task Categories modified."
        },
        "userFieldValues": {
            "type": "integer",
            "nullable": true,
            "description": "The mount of User Field Values modified."
        },
        "activityCodeValues": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Activity Code Values modified."
        },
        "resourceCodeValues": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Resource Code Values modified."
        },
        "resourceAssignments": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Resource Assignments modified."
        },
        "activityCodeValuesAssignments": {
            "type": "integer",
            "nullable": true,
            "description": "The mount of Activity Code Values Assignments modified."
        },
        "resourceCodeValuesAssignments": {
            "type": "integer",
            "nullable": true,
            "description": "The amount of Resource Code Values Assignments modified."
        }
    },
    "description": "Synchronizer modification counts.",
    "additionalProperties": false
}

Synchronizer Expanded Data Model

Expanded details of a Synchronizer.

created

SynchronizerWriteLogsModel

deleted

SynchronizerWriteLogsModel

updated

SynchronizerWriteLogsModel

warnings

SynchronizerLogsMessage[]

Warnings that occurred during last Synchronization.

json

{
    "type": "object",
    "title": "Synchronizer Expanded Data Model",
    "properties": {
        "created": {
            "$ref": "#/components/schemas/SynchronizerWriteLogsModel"
        },
        "deleted": {
            "$ref": "#/components/schemas/SynchronizerWriteLogsModel"
        },
        "updated": {
            "$ref": "#/components/schemas/SynchronizerWriteLogsModel"
        },
        "warnings": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/SynchronizerLogsMessage"
            },
            "description": "Warnings that occurred during last Synchronization."
        }
    },
    "description": "Expanded details of a Synchronizer.",
    "additionalProperties": false
}

Microsoft Project Synchronizer

Representation of a Microsoft Project Synchronizer.

String

The unique identifier of the Synchronizer.

deleted

Boolean, null

Is this Synchronizer deleted.

projectName

String

The name of the project.

projectPath

String

The path of the project.

synchronizerName

String

The name of the Synchronizer.

originalProjectName

String

The name of the initial import project.

originalProjectPath

String

The path of the initial import project.

synchronizationTime

Date-time

The date on which the synchronization occurred.

synchronizationType

SynchronizationType

synchronizationDetails

SynchronizerExpandedDetails

originalSynchronizationTime

Date-time

The date on which the initial import occurred.

originalSynchronizationType

SynchronizationType

json

{
    "type": "object",
    "title": "Microsoft Project Synchronizer",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Synchronizer."
        },
        "deleted": {
            "type": "boolean",
            "nullable": true,
            "description": "Is this Synchronizer deleted."
        },
        "projectName": {
            "type": "string",
            "description": "The name of the project."
        },
        "projectPath": {
            "type": "string",
            "description": "The path of the project."
        },
        "synchronizerName": {
            "type": "string",
            "description": "The name of the Synchronizer."
        },
        "originalProjectName": {
            "type": "string",
            "description": "The name of the initial import project."
        },
        "originalProjectPath": {
            "type": "string",
            "description": "The path of the initial import project."
        },
        "synchronizationTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date on which the synchronization occurred."
        },
        "synchronizationType": {
            "$ref": "#/components/schemas/SynchronizationType"
        },
        "synchronizationDetails": {
            "$ref": "#/components/schemas/SynchronizerExpandedDetails"
        },
        "originalSynchronizationTime": {
            "type": "string",
            "format": "date-time",
            "description": "The date on which the initial import occurred."
        },
        "originalSynchronizationType": {
            "$ref": "#/components/schemas/SynchronizationType"
        }
    },
    "description": "Representation of a Microsoft Project Synchronizer.",
    "additionalProperties": false
}

Microsoft Project Synchronizer Response

Container for Microsoft Project Synchronizer object.

synchronizer

MicrosoftProjectSynchronizer

json

{
    "type": "object",
    "title": "Microsoft Project Synchronizer Response",
    "properties": {
        "synchronizer": {
            "$ref": "#/components/schemas/MicrosoftProjectSynchronizer"
        }
    },
    "description": "Container for Microsoft Project Synchronizer object.",
    "additionalProperties": false
}

Was this page helpful?

V10 Endpoint

Authentication

Rate limits

Request

Request parameters

Request headers

Response

Response 200 OK

Response headers

Response 304 Not Modified

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Error

Error Response

Synchronization Type

Synchronizer Logs Message

Synchronizer Write Logs Model

Synchronizer Expanded Data Model

Microsoft Project Synchronizer

Microsoft Project Synchronizer Response