Start Primavera Import - Schedules

Schedules

Download API definition:

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

POST https://dev-api.bentley.com/schedules/{scheduleId}/imports/primavera

Starts a Primavera P6 import for the provided Schedule. The request body must include a reference to an uploaded file and the list of Primavera projects to import. This operation is asynchronous and returns a long-running operation identifier.

V10 Endpoint

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

Operation

Operations, also known as LROs (Long Running Operations), are time-consuming tasks that would not be completed in the appropriate timeframe for a single request response. Endpoints that use operations return an operation id that can be used on a separate endpoint to track the progress of the task that is being handled.

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

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.

Defines the Primavera import request.

Request body

Primavera Import Request

fileId

String

The unique identifier of the uploaded file to import.

filePath

String

The original file name or path to the Primavera file.

projects

PrimaveraProjectInfo[]

The Primavera project(s) to import from the uploaded file.

synchronizerId

String, null

Optional id to correlate import synchronization.

options

PrimaveraImportOptions, null

Optional import options.

Example

json

{
    "fileId": "83192206-c73b-4770-ab81-0682c72e6e42",
    "filePath": "acme_primavera.xml",
    "synchronizerId": "b6f64a55-d462-4f2d-b943-7254416714e5",
    "projects": [{
        "name": "AcmeProject",
        "id": "1"
    }],
    "options": {
        "importTasks": true,
        "importLinks": true,
        "importTaskConstraints": true,
        "importCosts": true,
        "importCalendars": true,
        "importResources": true,
        "importResourceAssignments": true,
        "importActivityCodes": true,
        "mergeActivityCodes": true,
        "importActivityCodeAssignments": true,
        "importUserFields": true,
        "importUserFieldValues": true,
        "importResourceCodes": true,
        "mergeResourceCodes": true,
        "importResourceCodeAssignments": true,
        "importCostAccounts": true,
        "importNotebooks": true,
        "createProjectNodes": true,
        "useWBSCodes": true,
        "constrainExternalDates": true
    }
}

Response

Response 202 Accepted

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

json

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

Response headers

Operation-Id

The unique identifier of the Operation.

Operation-Location

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

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": "MissingProperties",
                "message": "Missing required property.",
                "target": "fileId"
            },
            {
                "code": "MissingProperties",
                "message": "Missing required property.",
                "target": "filePath"
            },
            {
                "code": "MissingProperties",
                "message": "Missing required property.",
                "target": "projects"
            }
        ],
        "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 403 Forbidden

User is not authorized to import a Primavera project.

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

Provided file is invalid or not supported as a Primavera import.

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

Primavera Project Info

Information about a Primavera project contained within the uploaded file.

name

String

Name of the Primavera project.

String

Identifier of the Primavera project.

userDefinedId

String, null

User defined identifier of the Primavera project.

json

{
    "title": "Primavera Project Info",
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the Primavera project."
        },
        "id": {
            "type": "string",
            "description": "Identifier of the Primavera project."
        },
        "userDefinedId": {
            "type": "string",
            "description": "User defined identifier of the Primavera project.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Information about a Primavera project contained within the uploaded file."
}

Primavera Import Options

Options to control which Primavera entities are imported.

importTasks

Boolean

importLinks

Boolean

importTaskConstraints

Boolean

importCosts

Boolean

importCalendars

Boolean

importResources

Boolean

importResourceAssignments

Boolean

importActivityCodes

Boolean

mergeActivityCodes

Boolean

importActivityCodeAssignments

Boolean

importUserFields

Boolean

importUserFieldValues

Boolean

importResourceCodes

Boolean

mergeResourceCodes

Boolean

importResourceCodeAssignments

Boolean

importCostAccounts

Boolean

importNotebooks

Boolean

createProjectNodes

Boolean

useWBSCodes

Boolean

constrainExternalDates

Boolean

json

{
    "title": "Primavera Import Options",
    "type": "object",
    "properties": {
        "importTasks": {
            "type": "boolean"
        },
        "importLinks": {
            "type": "boolean"
        },
        "importTaskConstraints": {
            "type": "boolean"
        },
        "importCosts": {
            "type": "boolean"
        },
        "importCalendars": {
            "type": "boolean"
        },
        "importResources": {
            "type": "boolean"
        },
        "importResourceAssignments": {
            "type": "boolean"
        },
        "importActivityCodes": {
            "type": "boolean"
        },
        "mergeActivityCodes": {
            "type": "boolean"
        },
        "importActivityCodeAssignments": {
            "type": "boolean"
        },
        "importUserFields": {
            "type": "boolean"
        },
        "importUserFieldValues": {
            "type": "boolean"
        },
        "importResourceCodes": {
            "type": "boolean"
        },
        "mergeResourceCodes": {
            "type": "boolean"
        },
        "importResourceCodeAssignments": {
            "type": "boolean"
        },
        "importCostAccounts": {
            "type": "boolean"
        },
        "importNotebooks": {
            "type": "boolean"
        },
        "createProjectNodes": {
            "type": "boolean"
        },
        "useWBSCodes": {
            "type": "boolean"
        },
        "constrainExternalDates": {
            "type": "boolean"
        }
    },
    "additionalProperties": false,
    "description": "Options to control which Primavera entities are imported."
}

Primavera Import Request

Request for starting a Primavera import.

fileId

String

The unique identifier of the uploaded file to import.

filePath

String

The original file name or path to the Primavera file.

projects

PrimaveraProjectInfo[]

The Primavera project(s) to import from the uploaded file.

synchronizerId

String, null

Optional id to correlate import synchronization.

options

PrimaveraImportOptions, null

Optional import options.

json

{
    "title": "Primavera Import Request",
    "type": "object",
    "properties": {
        "fileId": {
            "type": "string",
            "description": "The unique identifier of the uploaded file to import."
        },
        "filePath": {
            "type": "string",
            "description": "The original file name or path to the Primavera file."
        },
        "projects": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/PrimaveraProjectInfo"
            },
            "description": "The Primavera project(s) to import from the uploaded file."
        },
        "synchronizerId": {
            "type": "string",
            "description": "Optional id to correlate import synchronization.",
            "nullable": true
        },
        "options": {
            "$ref": "#/components/schemas/PrimaveraImportOptions",
            "description": "Optional import options.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Request for starting a Primavera import."
}

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."
}

Operation Create Response

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

operation

OperationCreateResponseProperties

Contains properties of the created long-running operation.

_links

OperationLocationLink

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

json

{
    "title": "Operation Create Response",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation."
        },
        "_links": {
            "$ref": "#/components/schemas/OperationLocationLink",
            "description": "Contains the hyperlink to the Operations endpoint to check the operation information."
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the created long-running operation, and a link to this operation."
}

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
}