Get Task Scheduling Analyses - Schedules

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/scheduling-analyses[?$top][&$continuationToken][&deltaToken]

Get Task Scheduling Analyses

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

$top

The $top system query option requests the number of items in the queried collection to be included in the result. When $top parameter is not provided default is set to 100. $top value cannot exceed 10000.

$continuationToken

A token used for pagination to retrieve the next set of results. It indicates where the previous page of results ended, allowing you to fetch the subsequent batch of data.

deltaToken

A token used for pagination to retrieve only those items which changed since the generation of the token. Delta token is generated on the last page.

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

{
    "taskSchedulingAnalyses": [{
            "isCritical": false,
            "downstreamTotalFloat": 229,
            "downstreamFreeFloat": 0,
            "taskId": "a98dcc19-e475-4fff-af1d-eb6d19c7660c"
        },
        {
            "isCritical": false,
            "downstreamTotalFloat": 200,
            "downstreamFreeFloat": 0,
            "taskId": "1f93f0a2-236a-4abb-8297-3c5b4b26c0da"
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/tasks/scheduling-analyses?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/tasks/scheduling-analyses?$top=2&$continuationToken=eyJQcmltYXJ5U2tpcFRva2VuIjoiMDAwNGE5MDAtM2UxYy00NGNlLThhMzktYWUxZWRlY2M1MWY0IiwiU2Vjb25kYXJ5U2tpcFRva2VuIjpudWxsfQ=="
        }
    }
}

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

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

Paging Links

URLs for redoing the current request and/or getting the next page of results if applicable.

self

Link

Relative URL for redoing the current request.

Link, null

Relative URL for getting the next page of results.

json

{
    "title": "Paging Links",
    "type": "object",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "Relative URL for redoing the current request."
        },
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "Relative URL for getting the next page of results.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable."
}

Task Scheduling Analysis

Representation of a Task Scheduling Analysis.

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.

json

{
    "title": "Task Scheduling Analysis",
    "type": "object",
    "properties": {
        "downstreamTotalFloat": {
            "type": "integer",
            "description": "The amount of seconds a Task may slip forward before affecting the Project End Date.",
            "format": "int32"
        },
        "downstreamFreeFloat": {
            "type": "integer",
            "description": "The amount of seconds a Task may slip forward before affecting its immediately succeeding task(s).",
            "format": "int32"
        },
        "isCritical": {
            "type": "boolean",
            "description": "True if the task is on the Critical Path. False if the task is not critical."
        },
        "taskId": {
            "type": "string",
            "description": "The unique identifier of the Task."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Task Scheduling Analysis."
}

Task Scheduling Analysis Response

List of Task Schedule Analyses.

taskSchedulingAnalyses

TaskSchedulingAnalysis[]

A list of Task Schedule Analyses.

_links

PagingLinks

Contains the hyperlinks to the current and next pages of results.

json

{
    "title": "Task Scheduling Analysis Response",
    "type": "object",
    "properties": {
        "taskSchedulingAnalyses": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskSchedulingAnalysis"
            },
            "description": "A list of Task Schedule Analyses."
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "additionalProperties": false,
    "description": "List of Task Schedule Analyses."
}

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

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",
    "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?

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

Link

Paging Links

Task Scheduling Analysis

Task Scheduling Analysis Response

Error

Error Response