Table of contents
Schedules
Download API definition:
This operation is a Technical Preview and is available for testing purposes only. Do not use in production.
GET https://dev-api.bentley.com/schedules/{scheduleId}/tasks/{taskId}/scheduling-analysis

Get Task Scheduling Analysis

Request parameters

Name
Required?
Description
taskId
Yes

The unique identifier of the Task.

scheduleId
Yes

The unique identifier of the Schedule.

Request headers

Name
Required?
Description
If-None-Match
No

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

Accept
Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response 200 OK

OK

json
{
    "taskSchedulingAnalysis": {
        "isCritical": false,
        "downstreamTotalFloat": 200,
        "downstreamFreeFloat": 0,
        "taskId": "1f93f0a2-236a-4abb-8297-3c5b4b26c0da"
    }
}

Response headers

Name
Description
ETag

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

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 404 Not Found

This response indicates that the provided Task 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

Name
Description
retry-after

Number of seconds to wait until client is allowed to make more requests.

Task Scheduling Analysis

Representation of a Task Scheduling Analysis.

Name
Type
Description
downstreamTotalFloat
Int32

The amount of seconds a Task may slip forward before affecting the Project End Date.

downstreamFreeFloat
Int32

The amount of seconds a Task may slip forward before affecting its immediately succeeding task(s).

isCritical
Boolean

True if the task is on the Critical Path. False if the task is not critical.

taskId
String

The unique identifier of the Task.

Task Scheduling Analysis Response

Container for Task Schedule Analysis object.

Name
Type
Description
taskSchedulingAnalysis

Task Scheduling Analysis Properties.

Error

Contains error information.

Name
Type
Description
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.

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.

Name
Type
Description
error

Error information.

Was this page helpful?