Get Tasks Resource Assignments - Schedules

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.

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",
            "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",
            "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/resource-assignments?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/tasks/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.

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 422 Unprocessable Entity

The 422 (Unprocessable Entity) 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."
    }
}

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

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

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

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

Resource Utilization

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

percentOfOneResourceUnitPerDay

Double

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

percentOfTotalResourceUnitsPerDay

Double

The percentage of total resource units per day.

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

json

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

Task Resource Assignment

Representation of a Task Resource Assignment.

actualUtilization

ActualResourceUtilization, null

The actual utilization of the resource.

appearanceProfileId

String

The unique identifier of the Appearance Profile.

drivingResource

Boolean, null

Use the resource when calculating task duration.

fixedUnits

Boolean, null

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

String

The unique identifier of the Task Resource Assignment.

plannedUtilization

ResourceUtilization, null

The planned utilization of the resource.

remainingUtilization

ResourceUtilization, null

The remaining utilization of the resource.

resourceId

String

The unique identifier of the Resource.

taskId

String

The unique identifier of the Task.

json

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

Task Resource Assignments Response

List of Task Resource assignments.

resourceAssignments

TaskResourceAssignment[]

A list of Task Resource assignments.

_links

PagingLinks

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

json

{
    "title": "Task Resource Assignments Response",
    "type": "object",
    "properties": {
        "resourceAssignments": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskResourceAssignment"
            },
            "description": "A list of Task Resource assignments."
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "additionalProperties": false,
    "description": "List of Task Resource assignments."
}

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
}

Was this page helpful?

Authentication

Rate limits

Request

Request parameters

Request headers

Response

Response 200 OK

Response headers

Response 304 Not Modified

Response 401 Unauthorized

Response 404 Not Found

Response 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Actual Resource Utilization

Link

Paging Links

Resource Utilization

Task Resource Assignment

Task Resource Assignments Response

DetailedError

Detailed Error Response

Error

Error Response