Creates Baseline for a Schedule.
Baseline
Baselines function as a snapshot that stores information about the schedule during the creation of Baseline. The primary goal of a baseline is to store specific information about tasks and their links. This information can be later used to compare how schedule has changed over time. When deleting a baseline it also deletes the baselined tasks and their links.
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 parameters
The unique identifier of the Schedule.
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Entity to post for creation.
Request body
Baseline Create Request
The unique identifier of the Baseline.
The name of the baseline.
Example
{ "name": "New Baseline" }
Response 201 Created
Created
{ "baseline": { "createdOn": "2025-12-03T12:35:20Z", "deleted": false, "id": "b1765057-fa96-4169-bd30-e60213dc45c1", "name": "New Baseline" } }
Response headers
A header that identifies a specific version of a resource or resource collection. For more information see the official documentation.
A header that identifies the location of a specific resource. For more information see the official documentation.
The unique identifier of the Operation.
URL to the Operations endpoint with pre-entered Operation ID.
Response 202 Accepted
This response indicates that the requested long-running operation was Accepted.
{ "baseline": { "id": "2a0bcc5b-d4f2-47f0-9a60-abf9f1eb58d9" }, "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
The unique identifier of the Operation.
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)
{ "error": { "code": "InvalidSchedulesRequest", "details": [{ "code": "InvalidValue", "message": "The 'name' property must not exceed 255 characters.", "target": "name" }], "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.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 403 Forbidden
User is not authorized to create a Baseline.
{ "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.
{ "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.
{ "error": { "code": "BaselineExists", "message": "Baseline with provided 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.
{ "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.
Baseline
Representation of a Baseline.
The date on which the Baseline was created.
Is this Baseline deleted.
The unique identifier of the Baseline.
The name of the Baseline.
{ "title": "Baseline", "type": "object", "properties": { "createdOn": { "type": "string", "description": "The date on which the Baseline was created.", "format": "date-time" }, "deleted": { "type": "boolean", "description": "Is this Baseline deleted.", "nullable": true }, "id": { "type": "string", "description": "The unique identifier of the Baseline." }, "name": { "type": "string", "description": "The name of the Baseline." } }, "additionalProperties": false, "description": "Representation of a Baseline." }
Baseline Create Request
Properties of the baseline to be created.
The unique identifier of the Baseline.
The name of the baseline.
{ "title": "Baseline Create Request", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the Baseline.", "nullable": true }, "name": { "type": "string", "description": "The name of the baseline." } }, "additionalProperties": false, "description": "Properties of the baseline to be created." }
Baseline Create Response
Contains properties of the created Baseline.
Contains properties of the created long-running operation.
Contains the hyperlink to the Operations endpoint to check the operation information.
{ "title": "Baseline Create Response", "type": "object", "properties": { "baseline": { "$ref": "#/components/schemas/Baseline", "description": "Properties of the created Baseline." }, "operation": { "$ref": "#/components/schemas/OperationCreateResponseProperties", "description": "Contains properties of the created long-running operation.", "nullable": true }, "_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 Baseline.", "x-codegen-extends-class": "OperationCreateResponse" }
Baseline Create Response
Contains properties of the created long-running operation, and a link to this operation.
Contains properties of the created long-running operation.
Contains the hyperlink to the Operations endpoint to check the operation information.
{ "title": "Baseline Create Response", "type": "object", "properties": { "baseline": { "$ref": "#/components/schemas/BaselineOperationResponseProperties", "description": "Properties of the Baseline to be created." }, "operation": { "$ref": "#/components/schemas/OperationCreateResponseProperties", "description": "Contains properties of the created long-running operation.", "nullable": true }, "_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" }
Baseline Create Response Properties
Contains properties of the Baseline that is queued for creation.
The unique identifier of the Baseline.
{ "title": "Baseline Create Response Properties", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the Baseline." } }, "additionalProperties": false, "description": "Contains properties of the Baseline that is queued for creation." }
Link
Hyperlink container.
Hyperlink to the specific entity.
{ "type": "object", "properties": { "href": { "type": "string", "description": "Hyperlink to the specific entity." } }, "additionalProperties": false, "description": "Hyperlink container." }
Operation Create Response Properties
Contains the id of the created long-running operation.
The unique identifier of the Operation.
{ "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.
{ "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.
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 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.
{ "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.
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?