Retrieves all Runs for the specified connection.
Notes
The Prefer
header can be used to specify how much result metadata is desired by the client. The Prefer
request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.
This operation supports "return=representation"
and "return=minimal"
preferences.
The "return=representation"
preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The "return=minimal"
preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if Prefer
header is not specified.
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.
Request parameters
Request headers
OAuth access token with itwin-platform
scope
Setting to application/vnd.bentley.itwin-platform.v1+json
is recommended.
Response 200 OK
OK
{ "runs": [{ "id": "5a9c04ef-b1e2-4b70-bee1-2689075fc178", "state": "Completed", "result": "Success" }], "_links": { "self": { "href": "https://api.bentley.com/synchronization/imodels/manifestconnections/{connectionId}/runs?$skip=0&$top=100" }, "prev": { "href": "https://api.bentley.com/synchronization/imodels/manifestconnections/{connectionId}/runs?$skip=100&$top=100" }, "next": { "href": "https://api.bentley.com/synchronization/imodels/manifestconnections/{connectionId}/runs?$skip=200&$top=100" } } }
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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified connection was not found.
{ "error": { "code": "ManifestConnectionNotFound", "message": "Requested ManifestConnection is not available." } }
Response 422 Unprocessable Entity
Invalid request to get connection run.
{ "error": { "code": "InvalidManifestConnectionRunsRequest", "message": "Cannot perform operation.", "details": [{ "code": "InvalidValue", "message": "Provided connectionId value is not valid.", "target": "connectionId" }, { "code": "InvalidValue", "message": "Page size is out of limits.", "target": "$skip" }, { "code": "InvalidValue", "message": "Page size is out of limits.", "target": "$top" } ] } }
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.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
Runs (prefer return=minimal)
A set of manifest run entities representing a minimal number of properties.
{ "title": "Runs (prefer return=minimal)", "type": "object", "properties": { "runs": { "type": "array", "items": { "$ref": "#/components/schemas/manifest-minimal-run" }, "description": "A set of manifest run entities representing a minimal number of properties." }, "_links": { "$ref": "#/components/schemas/Links", "description": "Links to current, previous, and next run." } }, "additionalProperties": false }
Runs (prefer return=representation)
{ "title": "Runs (prefer return=representation)", "type": "object", "properties": { "runs": { "type": "array", "items": { "$ref": "#/components/schemas/manifest-run" }, "description": "A set of manifest run entities representing all manifest run properties." }, "_links": { "$ref": "#/components/schemas/Links", "description": "Links to current, previous, and next run." } }, "additionalProperties": false }
Manifest Connection Run
A connection run id.
{ "title": "Manifest Connection Run", "type": "object", "properties": { "id": { "type": "string", "description": "A connection run id." }, "state": { "$ref": "#/components/schemas/execution-state", "description": "A string indicating current execution status of the run." }, "result": { "$ref": "#/components/schemas/execution-result", "description": "A string indicating outcome of the executed run." } }, "additionalProperties": false }
Manifest Connection Run
A connection run id.
Connection id.
A timestamp when connection run started.
A timestamp when connection run ended.
{ "title": "Manifest Connection Run", "type": "object", "properties": { "id": { "type": "string", "description": "A connection run id." }, "connectionId": { "type": "string", "description": "Connection id." }, "startDateTime": { "type": "string", "description": "A timestamp when connection run started." }, "endDateTime": { "type": "string", "description": "A timestamp when connection run ended." }, "phase": { "$ref": "#/components/schemas/job-phase", "description": "Job phase." }, "state": { "$ref": "#/components/schemas/execution-state", "description": "A string indicating current execution status of the run." }, "result": { "$ref": "#/components/schemas/execution-result", "description": "A string indicating outcome of the executed run." }, "error": { "$ref": "#/components/schemas/run-error-details", "description": "Run error entity." }, "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/manifest-job" }, "description": "An array of manifest job entities." } }, "additionalProperties": false }
Run error details
Error key.
More information about run error.
{ "title": "Run error details", "type": "object", "nullable": true, "properties": { "errorKey": { "type": "string", "description": "Error key." }, "description": { "type": "string", "description": "More information about run error." } }, "additionalProperties": false }
Manifest Connection Run's Job
A manifest job id.
A timestamp when manifest job started.
A timestamp when manifest job ended.
A string indicating current execution status of the job.
A string indicating outcome of the executed job.
{ "title": "Manifest Connection Run's Job", "type": "object", "properties": { "id": { "type": "string", "description": "A manifest job id." }, "startDateTime": { "type": "string", "description": "A timestamp when manifest job started." }, "endDateTime": { "type": "string", "description": "A timestamp when manifest job ended." }, "state": { "type": "string", "description": "A string indicating current execution status of the job." }, "result": { "type": "string", "description": "A string indicating outcome of the executed job." }, "connectorType": { "$ref": "#/components/schemas/connector-type", "description": "Type of connector used for synchronization. Refer [supported connector format](https://dev-developer.bentley.com/apis/synchronization/supported-formats/) for details." }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/manifest-task" }, "description": "An array of manifest task entities." } }, "additionalProperties": false }
Manifest Connection Run Job's Task
A manifest task id.
Source file id.
A timestamp when manifest task started.
A timestamp when manifest task ended.
The number of attempts when manifest task was retried.
A string indicating current status of the manifest task.
A string indicating outcome of the manifest task.
{ "title": "Manifest Connection Run Job's Task", "type": "object", "properties": { "id": { "type": "string", "description": "A manifest task id." }, "sourceFileId": { "type": "string", "description": "Source file id." }, "startDateTime": { "type": "string", "description": "A timestamp when manifest task started." }, "endDateTime": { "type": "string", "description": "A timestamp when manifest task ended." }, "retryAttempts": { "type": "integer", "description": "The number of attempts when manifest task was retried." }, "state": { "type": "string", "description": "A string indicating current status of the manifest task." }, "result": { "type": "string", "description": "A string indicating outcome of the manifest task." }, "error": { "$ref": "#/components/schemas/task-error", "description": "Task error entity." }, "details": { "$ref": "#/components/schemas/task-details", "description": "Task result details." } }, "additionalProperties": false }
Job Phase
One of 'Preprocessor', 'MasterFile', 'ReferenceFile'.
{ "title": "Job Phase", "description": "One of 'Preprocessor', 'MasterFile', 'ReferenceFile'.", "type": "string", "enum": [ "Preprocessor", "MasterFile", "ReferenceFile" ] }
Execution State
One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'.
{ "title": "Execution State", "description": "One of 'NotStarted', 'Idle', 'WaitingToExecute', 'WaitingToRetry', 'Executing', 'Finalizing', 'Completed', 'Queued'.", "type": "string", "enum": [ "NotStarted", "Idle", "WaitingToExecute", "WaitingToRetry", "Executing", "Finalizing", "Completed", "Queued" ] }
Execution Result
One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'.
{ "title": "Execution Result", "description": "One of 'Undetermined', 'Success', 'Error', 'PartialSuccess', 'Skipped', 'Canceled', 'TimedOut'.", "type": "string", "enum": [ "Undetermined", "Success", "Error", "PartialSuccess", "Skipped", "Canceled", "TimedOut" ] }
task-error
Error code.
A human-readable representation of the error.
More specific information about the error.
An integer representing connector exit code.
System.
Phase.
Category.
Description key.
Description.
A link to public documentation for known errors.
A boolean value representing if the error is user fixable or not.
{ "type": "object", "properties": { "errorCode": { "type": "string", "description": "Error code." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "details": { "type": "string", "description": "More specific information about the error." }, "bridgeExitCode": { "type": "integer", "description": "An integer representing connector exit code." }, "system": { "type": "string", "description": "System." }, "phase": { "type": "string", "description": "Phase." }, "category": { "type": "string", "description": "Category." }, "descriptionKey": { "type": "string", "description": "Description key." }, "description": { "type": "string", "description": "Description." }, "kbArticleLink": { "type": "string", "description": "A link to public documentation for known errors." }, "canUserFix": { "type": "boolean", "description": "A boolean value representing if the error is user fixable or not." } }, "additionalProperties": false }
Task details
{ "type": "object", "title": "Task details", "properties": { "synchronizationReport": { "$ref": "#/components/schemas/synchronization-report", "description": "Synchronization result summary" } }, "additionalProperties": false }
Synchronization report
Error message explaining the result
Number of errors in the report
Number of warnings in the report
Number of other issues in the report
{ "title": "Synchronization report", "type": "object", "properties": { "suggestedAction": { "$ref": "#/components/schemas/suggested-action", "description": "Most severe issue type" }, "message": { "type": "string", "description": "Error message explaining the result" }, "totalErrorsCount": { "type": "integer", "description": "Number of errors in the report" }, "totalWarningsCount": { "type": "integer", "description": "Number of warnings in the report" }, "totalOtherIssuesCount": { "type": "integer", "description": "Number of other issues in the report" } }, "additionalProperties": false }
Suggested action
Error severity level
{ "title": "Suggested action", "type": "string", "description": "Error severity level", "enum": [ "Error", "Warning", "Info" ] }
Link
Hyperlink to the specific entity.
{ "type": "object", "properties": { "href": { "type": "string", "description": "Hyperlink to the specific entity." } }, "additionalProperties": false }
Links (paging)
URLs for redoing the current request, getting to the previous or next page of results.
{ "title": "Links (paging)", "type": "object", "description": "URLs for redoing the current request, getting to the previous or next page of results.", "properties": { "self": { "$ref": "#/components/schemas/Link", "description": "URL for redoing the current request." }, "next": { "$ref": "#/components/schemas/Link", "description": "URL for getting the next page of results." }, "prev": { "$ref": "#/components/schemas/Link", "description": "URL for getting the previous page of results." } }, "additionalProperties": false }
Connector type
One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW'. Name of the Connector that is used for synchronization.
{ "title": "Connector type", "type": "string", "description": "One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW'. Name of the Connector that is used for synchronization.", "enum": [ "AUTOPLANT", "CIVIL", "CIVIL3D", "DWG", "GEOSPATIAL", "IFC", "MSTN", "NWD", "OBD", "OPENTOWER", "REVIT", "SPPID", "SPXREVIEW" ] }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "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
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.
{ "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?