Get Resource Group - Schedules

Overview

Samples

Reference

View All

Animation 3D Path Assignments

Animation 3D Paths

Animation 3D Transforms

Animation Bindings

Appearance Profiles

Calendars

Code Values

Codes

Operations

Resource Groups

GETGet Resource Group

GETGet Resource Group Code Values

GETGet Resource Group User Field Values

GETGet Resource Groups

GETGet Resource Groups Code Value Assignments

GETGet Resource Groups Resources

GETGet Resource Groups User Field Values

Resource Status Categories

Resource Status History

Resource Status Items

Resource Status Sets

Resources

Schedules

Task Links

Task Statuses

Tasks

User Fields

Changelog

Schedules

Download API definition:

This API is a Technical Preview and is available for testing purposes only. Do not use in production.

Get Resource Group

GET https://dev-api.bentley.com/schedules/{scheduleId}/resource-groups/{resourceGroupId}

Gets the details of a Resource Group.

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

resourceGroupId

Yes

Unique resource group Id.

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.

Response 200 OK

Success

json

{
    "resourceGroup": {
        "description": "Test resource group",
        "foremanResourceId": "479410c4-e9eb-4429-8638-814dc86a7287",
        "generalForemanResourceId": "22a7eae3-cd00-4bf6-b562-561cad2a6f68",
        "id": "49aa4a19-e1ff-4a03-a97c-dff77b746761",
        "name": "Resource Group 1",
        "plannerResourceId": "a1f4d12e-940a-4755-94ca-f633c6fa035d",
        "superintendentResourceId": "247fae89-6ee0-4dbe-bbc7-dd9cdb7a6f4c",
        "url": "https://example.com",
        "userDefinedId": "Custom Id 001"
    }
}

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 Resource Group or Schedule is not available.

json

{
    "error": {
        "code": "ResourceGroupNotFound",
        "message": "Requested Resource Group is not available."
    }
}

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

Resource Group

Representation of a Resource Group.

description

String, null

The description of the Resource Group.

foremanResourceId

String, null

The unique identifier of the Human Resource that is the Foreman of the Resource Group.

generalForemanResourceId

String, null

The unique identifier of the Human Resource that is the General Foreman of the Resource Group.

String

The unique identifier of the Resource Group.

name

String

The name of the Resource Group.

plannerResourceId

String, null

The unique identifier of the Human Resource that is the Planner of the Resource Group.

superintendentResourceId

String, null

The unique identifier of the Human Resource that is the Superintendant of the Resource Group.

url

String, null

A URL associated with the Resource Group.

userDefinedId

String, null

A unique Resource Group Id defined by the user.

json

{
    "title": "Resource Group",
    "type": "object",
    "properties": {
        "description": {
            "type": "string",
            "description": "The description of the Resource Group.",
            "nullable": true
        },
        "foremanResourceId": {
            "type": "string",
            "description": "The unique identifier of the Human Resource that is the Foreman of the Resource Group.",
            "nullable": true
        },
        "generalForemanResourceId": {
            "type": "string",
            "description": "The unique identifier of the Human Resource that is the General Foreman of the Resource Group.",
            "nullable": true
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Resource Group."
        },
        "name": {
            "type": "string",
            "description": "The name of the Resource Group."
        },
        "plannerResourceId": {
            "type": "string",
            "description": "The unique identifier of the Human Resource that is the Planner of the Resource Group.",
            "nullable": true
        },
        "superintendentResourceId": {
            "type": "string",
            "description": "The unique identifier of the Human Resource that is the Superintendant of the Resource Group.",
            "nullable": true
        },
        "url": {
            "type": "string",
            "description": "A URL associated with the Resource Group.",
            "nullable": true
        },
        "userDefinedId": {
            "type": "string",
            "description": "A unique Resource Group Id defined by the user.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Resource Group."
}

Resource Group Response

Container for Resource Group object.

resourceGroup

ResourceGroup

Resource Group properties.

json

{
    "title": "Resource Group Response",
    "type": "object",
    "properties": {
        "resourceGroup": {
            "$ref": "#/components/schemas/ResourceGroup",
            "description": "Resource Group properties."
        }
    },
    "additionalProperties": false,
    "description": "Container for Resource Group object."
}

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?