Get Task Resource Assignments - Schedules

Schedules

Download API definition:

This API 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}/resource-assignments[?$top][&$continuationToken][&$deltaToken]

Gets all Resource Assignments of a Task.

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

taskId

Yes

The unique identifier of the Task.

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

{
    "resourceAssignments": [{
        "actualUtilization": {
            "resourceCount": 100,
            "resourceUnits": 100
        },
        "appearanceProfileId": "19cb3e29-ee63-4c12-93da-f0eb7898406b",
        "deleted": false,
        "id": "fc4c95f6-1ad9-42f8-abca-4871a9114d71",
        "plannedUtilization": {
            "percentOfOneResourceUnitPerDay": 1,
            "percentOfTotalResourceUnitsPerDay": 10,
            "resourceCount": 80,
            "resourceUnits": 80,
            "resourceUnitsPerDay": 8
        },
        "remainingUtilization": {
            "percentOfOneResourceUnitPerDay": 1,
            "percentOfTotalResourceUnitsPerDay": 10,
            "resourceCount": 20,
            "resourceUnits": 20,
            "resourceUnitsPerDay": 2
        },
        "resourceId": "dcc21e4d-5f8f-4e81-9254-82b8272f63ac",
        "taskId": "90829dd2-93da-4368-b437-161e05934cfe"
    }, {
        "actualUtilization": {
            "resourceCount": 100,
            "resourceUnits": 100
        },
        "appearanceProfileId": "eaf9cfd2-8d55-4a2e-b728-619fdc14f04c",
        "deleted": false,
        "id": "42898ecd-1178-42b0-92e9-8939a0eedde5",
        "plannedUtilization": {
            "percentOfOneResourceUnitPerDay": 1,
            "percentOfTotalResourceUnitsPerDay": 10,
            "resourceCount": 80,
            "resourceUnits": 80,
            "resourceUnitsPerDay": 8
        },
        "remainingUtilization": {
            "percentOfOneResourceUnitPerDay": 1,
            "percentOfTotalResourceUnitsPerDay": 10,
            "resourceCount": 20,
            "resourceUnits": 20,
            "resourceUnitsPerDay": 2
        },
        "resourceId": "7831d814-9d1e-45e4-bf10-2306ef93ff23",
        "taskId": "abfa479d-5f73-420d-a06f-f2119c56196e"
    }],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/tasks/abfa479d-5f73-420d-a06f-f2119c56196e/resource-assignments?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/tasks/abfa479d-5f73-420d-a06f-f2119c56196e/resource-assignments?$top=2&$continuationToken=eyJQcmltYXJ5U2tpcFRva2VuIjoiMDAwNGE5MDAtM2UxYy00NGNlLThhMzktYWUxZWRlY2M1MWY0IiwiU2Vjb25kYXJ5U2tpcFRva2VuIjpudWxsfQ=="
        }
    }
}

Response headers

Continuation-Token

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.

Delta-Token

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.

ETag

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

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": "InvalidValue",
            "message": "Top value is not positive, or exceeds maximum page size.",
            "target": "$top"
        }, {
            "code": "InvalidValue",
            "message": "Provided continuation token is invalid.",
            "target": "$continuationToken"
        }],
        "message": "The request contains invalid properties."
    }
}

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

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."
        }
    },
    "description": "Hyperlink container.",
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

Paging Links

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

Link

self

Link

json

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

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "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",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "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.",
    "additionalProperties": false
}

Resource Utilization

Container to represent the utilization properties of a task assigned resource.

resourceCount

Double

The number of people or machines needed for the task.

resourceUnits

Double

The resource units for the task (eg. 48 man-hours or 100 cubic yards).

resourceUnitsPerDay

Double

The resource unit progression per day (eg. 8 man-hours or 12 cubic yards).

percentOfOneResourceUnitPerDay

Double

The utilization percentage of one resource unit (human or equipment) per day.

percentOfTotalResourceUnitsPerDay

Double

The percentage of total resource units per day.

json

{
    "type": "object",
    "title": "Resource Utilization",
    "properties": {
        "resourceCount": {
            "type": "number",
            "format": "double",
            "description": "The number of people or machines needed for the task."
        },
        "resourceUnits": {
            "type": "number",
            "format": "double",
            "description": "The resource units for the task (eg. 48 man-hours or 100 cubic yards)."
        },
        "resourceUnitsPerDay": {
            "type": "number",
            "format": "double",
            "description": "The resource unit progression per day (eg. 8 man-hours or 12 cubic yards)."
        },
        "percentOfOneResourceUnitPerDay": {
            "type": "number",
            "format": "double",
            "description": "The utilization percentage of one resource unit (human or equipment) per day."
        },
        "percentOfTotalResourceUnitsPerDay": {
            "type": "number",
            "format": "double",
            "description": "The percentage of total resource units per day."
        }
    },
    "description": "Container to represent the utilization properties of a task assigned resource.",
    "additionalProperties": false
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/DetailedError",
            "description": "Error Detailed information."
        }
    },
    "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.",
    "additionalProperties": false
}

Task Resource Assignment

Representation of a Task Resource Assignment.

String

The unique identifier of the Task Resource Assignment.

taskId

String

The unique identifier of the Task.

deleted

Boolean, null

Is this Task Resource Assignment deleted.

fixedUnits

Boolean, null

Use utilization in units or resource count instead of units/time rate.

resourceId

String

The unique identifier of the Resource.

drivingResource

Boolean, null

Use the resource when calculating task duration.

actualUtilization

ActualResourceUtilization

plannedUtilization

ResourceUtilization

appearanceProfileId

String

The unique identifier of the Appearance Profile.

remainingUtilization

ResourceUtilization

json

{
    "type": "object",
    "title": "Task Resource Assignment",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Resource Assignment."
        },
        "taskId": {
            "type": "string",
            "description": "The unique identifier of the Task."
        },
        "deleted": {
            "type": "boolean",
            "nullable": true,
            "description": "Is this Task Resource Assignment deleted."
        },
        "fixedUnits": {
            "type": "boolean",
            "nullable": true,
            "description": "Use utilization in units or resource count instead of units/time rate."
        },
        "resourceId": {
            "type": "string",
            "description": "The unique identifier of the Resource."
        },
        "drivingResource": {
            "type": "boolean",
            "nullable": true,
            "description": "Use the resource when calculating task duration."
        },
        "actualUtilization": {
            "$ref": "#/components/schemas/ActualResourceUtilization"
        },
        "plannedUtilization": {
            "$ref": "#/components/schemas/ResourceUtilization"
        },
        "appearanceProfileId": {
            "type": "string",
            "description": "The unique identifier of the Appearance Profile."
        },
        "remainingUtilization": {
            "$ref": "#/components/schemas/ResourceUtilization"
        }
    },
    "description": "Representation of a Task Resource Assignment.",
    "additionalProperties": false
}

Actual Resource Utilization

Container to represent the actual utilization properties of a task assigned resource.

resourceCount

Double

The number of people or machines needed for the task.

resourceUnits

Double

The resource units for the task (eg. 48 man-hours or 100 cubic yards).

json

{
    "type": "object",
    "title": "Actual Resource Utilization",
    "properties": {
        "resourceCount": {
            "type": "number",
            "format": "double",
            "description": "The number of people or machines needed for the task."
        },
        "resourceUnits": {
            "type": "number",
            "format": "double",
            "description": "The resource units for the task (eg. 48 man-hours or 100 cubic yards)."
        }
    },
    "description": "Container to represent the actual utilization properties of a task assigned resource.",
    "additionalProperties": false
}

Task Resource Assignments Response

List of Task Resource assignments.

_links

PagingLinks

resourceAssignments

TaskResourceAssignment[]

A list of Task Resource assignments.

json

{
    "type": "object",
    "title": "Task Resource Assignments Response",
    "properties": {
        "_links": {
            "$ref": "#/components/schemas/PagingLinks"
        },
        "resourceAssignments": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskResourceAssignment"
            },
            "description": "A list of Task Resource assignments."
        }
    },
    "description": "List of Task Resource assignments.",
    "additionalProperties": false
}

Was this page helpful?

Authentication

Rate limits

Request

Request parameters

Request headers

Response

Response 200 OK

Response headers

Response 304 Not Modified

Response 400 Bad Request

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Link

Error

Paging Links

DetailedError

Error Response

Resource Utilization

Detailed Error Response

Task Resource Assignment

Actual Resource Utilization

Task Resource Assignments Response