Create Task Resource Assignment - Schedules

Schedules

Download API definition:

POST https://dev-api.bentley.com/schedules/{scheduleId}/tasks/resource-assignments

Assign a Resource to a Task.

Various types of Resources can be assigned to a Task, allowing to see the required Resources for the Task's completion. an Appearance Profile must also be assigned, these provide an indication of how a particular Resource is used.

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

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Entity to post for creation.

Request body

Task Resource Assignment Create Request

appearanceProfileId

String

The unique identifier of the Appearance Profile.

String

The unique identifier of the Task Resource Assignment.

resourceId

String

The unique identifier of the resource.

taskId

String

The unique identifier of the Task.

Example

json

{
    "appearanceProfileId": "42aa53f0-d4ad-4ec4-826b-fc6439090d46",
    "id": "91c3aaab-5c86-43ec-870d-6c34949ab1f3",
    "resourceId": "00639b2a-cb59-46d3-a7f0-5434bc335b02",
    "taskId": "53d03dd8-941e-4663-995e-d23a306ee3b6"
}

Response

Response 200 OK

This response indicates that the Task Resource Assignment was Created.

json

{
    "operation": {
        "id": "1604789f-68c4-46ba-b20d-8a19f8319362"
    },
    "resourceAssignment": {
        "actualUtilization": {
            "resourceCount": 0,
            "resourceUnits": 0
        },
        "appearanceProfileId": "42aa53f0-d4ad-4ec4-826b-fc6439090d46",
        "deleted": false,
        "id": "91c3aaab-5c86-43ec-870d-6c34949ab1f3",
        "plannedUtilization": {
            "percentOfOneResourceUnitPerDay": 0,
            "percentOfTotalResourceUnitsPerDay": 0,
            "resourceCount": 0,
            "resourceUnits": 0,
            "resourceUnitsPerDay": 0
        },
        "remainingUtilization": {
            "percentOfOneResourceUnitPerDay": 0,
            "percentOfTotalResourceUnitsPerDay": 0,
            "resourceCount": 0,
            "resourceUnits": 0,
            "resourceUnitsPerDay": 0
        },
        "resourceId": "00639b2a-cb59-46d3-a7f0-5434bc335b02",
        "taskId": "53d03dd8-941e-4663-995e-d23a306ee3b6"
    },
    "_links": {
        "operationLocation": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/operations/1604789f-68c4-46ba-b20d-8a19f8319362"
        }
    }
}

Response headers

ETag

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

Operation-Id

The unique identifier of the Operation.

Operation-Location

URL to the Operations endpoint with pre-entered Operation ID.

Response 202 Accepted

This response indicates that the requested long-running operation was Accepted.

json

{
    "operation": {
        "id": "1604789f-68c4-46ba-b20d-8a19f8319362"
    },
    "resourceAssignment": {
        "id": "91c3aaab-5c86-43ec-870d-6c34949ab1f3"
    },
    "_links": {
        "operationLocation": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/operations/1604789f-68c4-46ba-b20d-8a19f8319362"
        }
    }
}

Response headers

Operation-Id

The unique identifier of the Operation.

Operation-Location

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)

json

{
    "error": {
        "code": "InvalidSchedulesRequest",
        "details": [{
            "code": "InvalidValue",
            "message": "Provided 'appearanceProfileId' value is not valid. Requested Appearance Profile is not available.",
            "target": "appearanceProfileId"
        }],
        "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.

json

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

User is not authorized to create a Task Resource Assignment.

json

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

json

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

json

{
    "error": {
        "code": "DuplicateResourceAssignment",
        "message": "The Resource is already assigned to the Task."
    }
}

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

Operation Create Response Properties

Contains the id of the created long-running operation.

String, null

The unique identifier of the Operation.

json

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

operationLocation

Link

URL to the Operations endpoint with pre-entered Operation ID.

json

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

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.

deleted

Boolean, null

Is this Task Resource Assignment deleted.

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."
        },
        "deleted": {
            "type": "boolean",
            "description": "Is this Task Resource Assignment deleted.",
            "nullable": true
        },
        "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 Assignment Create Request

Properties of the Task Resource Assignment to be created.

appearanceProfileId

String

The unique identifier of the Appearance Profile.

String

The unique identifier of the Task Resource Assignment.

resourceId

String

The unique identifier of the resource.

taskId

String

The unique identifier of the Task.

json

{
    "title": "Task Resource Assignment Create Request",
    "type": "object",
    "properties": {
        "appearanceProfileId": {
            "type": "string",
            "description": "The unique identifier of the Appearance Profile."
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Resource Assignment."
        },
        "resourceId": {
            "type": "string",
            "description": "The unique identifier of the resource."
        },
        "taskId": {
            "type": "string",
            "description": "The unique identifier of the Task."
        }
    },
    "additionalProperties": false,
    "description": "Properties of the Task Resource Assignment to be created."
}

Task Resource Assignment Create Response

Contains properties of the created Resource Assignment.

operation

OperationCreateResponseProperties, null

Contains properties of the created long-running operation.

resourceAssignment

TaskResourceAssignment

Properties of the Resource Assignment.

_links

OperationLocationLink, null

Contains the hyperlink to the Operations endpoint to check the operation information.

json

{
    "title": "Task Resource Assignment Create Response",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation.",
            "nullable": true
        },
        "resourceAssignment": {
            "$ref": "#/components/schemas/TaskResourceAssignment",
            "description": "Properties of the Resource Assignment."
        },
        "_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 Resource Assignment.",
    "x-codegen-extends-class": "OperationCreateResponse"
}

Task Resource Assignment Operation Response

Contains properties of the created long-running operation, and a link to this operation.

operation

OperationCreateResponseProperties, null

Contains properties of the created long-running operation.

resourceAssignment

TaskResourceAssignmentOperationResponseProperties

Properties of the Task Resource Assignment to be created.

_links

OperationLocationLink, null

Contains the hyperlink to the Operations endpoint to check the operation information.

json

{
    "title": "Task Resource Assignment Operation Response",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation.",
            "nullable": true
        },
        "resourceAssignment": {
            "$ref": "#/components/schemas/TaskResourceAssignmentOperationResponseProperties",
            "description": "Properties of the Task Resource Assignment to be created."
        },
        "_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"
}

Task Resource Assignment Create Operation Properties

Contains properties of the Task Resource Assignment that is queued for creation.

String

The unique identifier of the Task Resource Assignment.

json

{
    "title": "Task Resource Assignment Create Operation Properties",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Resource Assignment."
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the Task Resource Assignment that is queued for creation."
}

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?