Получение функции

Используйте API Получение функции по идентификатору для получения конкретной функции в Control Room.

Запрос

GET https://{{ControlRoomURL}}/v1/usermanagement/roles/<role ID>

Header: X-Authorization <<authentication token>>

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Параметры запроса


Параметр	Тип	Требуется	Описание
идентификатор функции	Целое число	Да	Введите идентификатор функции.

Ответ

200 OK

{
    "id": 264,
    "createdBy": 10,
    "createdOn": "2022-04-12T12:12:39Z",
    "updatedBy": 10,
    "updatedOn": "2022-04-12T12:12:39Z",
    "tenantId": 1,
    "version": 0,
    "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
    "description": "",
    "name": "Device admin",
    "permissions": [
        {
            "id": 1345,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "managecredentials",
            "resourceId": null,
            "resourceType": "credentials"
        },
        {
            "id": 1424,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "delete",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1425,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "edit",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1344,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "myschedule",
            "resourceId": null,
            "resourceType": "taskscheduling"
        },
        {
            "id": 1426,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "view",
            "resourceId": null,
            "resourceType": "dashboard"
        },
        {
            "id": 1414,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "attestcredentials",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1381,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "register",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1321,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "view",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1423,
            "createdBy": 0,
            "createdOn": "2022-04-11T19:46:24Z",
            "updatedBy": 1,
            "updatedOn": "2022-04-11T19:46:24Z",
            "tenantId": 1,
            "version": 0,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "action": "all",
            "resourceId": null,
            "resourceType": "devices"
        }
    ],
    "countPrincipals": 0,
    "systemRole": false,
    "principals": [
        {
            "id": 21,
            "createdBy": 10,
            "createdOn": "2022-04-12T12:12:19Z",
            "updatedBy": 21,
            "updatedOn": "2022-04-13T03:37:08Z",
            "tenantId": 1,
            "version": 19,
            "tenantUuid": "06e42523-b44a-49f4-82dc-b8d420896761",
            "username": "john_user",
            "description": "User",
            "deleted": false,
            "disabled": false,
            "email": "john.doe@aa.com",
            "firstName": "John",
            "lastName": "Doe",
            "autoLoginEnabled": true,
            "emailVerified": true,
            "clientRegistered": false,
            "passwordSet": true,
            "questionsSet": true,
            "activeDirectory": false,
            "passwordChangedOn": "2022-04-12T12:13:35Z",
            "deviceCredentialAttested": false,
            "multipleLoginAllowed": true
        }
    ]
}

Параметры ответа


Параметр	Тип	Описание
идентификатор	Целое число	Уникальный идентификатор, представляющий созданную новую функцию.
имя	Строка	Имя созданной функции.
описание	Строка	Описание созданной функции.
версия	Целое число	Версия экземпляра функции.
createdBy	Целое число	Идентификатор пользователя, создавшего функцию.
createdOn	Строка	Временная метка создания функции.
кем обновлено	Целое число	Идентификатор пользователя, выполнившего последнее обновление функции.
дата обновления	Строка	Временная метка последнего обновления функции.
разрешения	Массив	Массив уникальных разрешений, которые были назначены функции.
участники	Массив	Массив уникальных пользователей, которые были назначены этой функции.

Прим.: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

The REST API responds to each request with an HTTP response code. For response codes, see API response codes.