Lire et examiner la documentation Automation Anywhere

Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

List Roles

  • Mis à jour le : 2022/01/30
    • Automation 360 v.x
    • Optimiser
    • Espace de travail RPA
    • Docs API

List Roles

Use the List Roles API to retrieve a list of roles in the Control Room. The endpoint supports pagination, sorting, and filtering.

Request

POST http://{{ControlRoomURL}}/v1/usermanagement/roles/list
Header: X-Authorization <<authentication token>>
Utilisez l’API Authentification pour générer un jeton JWT. Reportez-vous à la rubrique API d’authentification.
Request body without filters:
{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      
   },
   "fields":[
      
   ],
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}
Request body with filters:
{
   "sort":[
      {
         "field":"name",
         "direction":"asc"
      }
   ],
   "filter":{
      "operator":"and",
      "operands":[
         {
            "operator":"substring",
            "field":"name",
            "value":"Device"
         },
         {
            "operator":"gt",
            "field":"createdOn",
            "value":"2022-02-01T00:00:00.989Z"
         },
         {
            "operator":"lt",
            "field":"createdOn",
            "value":"2022-03-20T23:00:00.123Z"
         }
      ]
   },
   "fields":[],
   "page":{
      "offset":0,
      "total":100,
      "totalFilter":100,
      "length":200
   }
}

Request Parameters

Parameter Type Required Description
sort Array No By default, search results are sorted in descending order with respect to their ids. An alternative sorting is specified using the sort query parameter.

Enter the field by which you want to sort along with the direction asc (ascending) or desc (descending). For more information on sorting, see Filtres dans un corps de demande API

filter Object No Filters the result. For more information on sorting, see Filtres dans un corps de demande API
fields Array No Filter the result based on the fields.
page Object No The page object allows you to get the desired pages. For more information on pagination rules, see Filtres dans un corps de demande API

Response

{
    "page": {
        "offset": 0,
        "total": 21,
        "totalFilter": 1
    },
    "list": [
        {
            "id": 24,
            "name": "Device_admin",
            "description": "This is a device admin role",
            "countPrincipals": 1,
            "version": 1,
            "createdBy": 1,
            "createdOn": "2022-03-17T19:32:20.620Z",
            "updatedBy": 1,
            "updatedOn": "2022-03-24T02:20:13.787Z",
            "systemRole": false
        }
    ]
}

Response Parameters

Parameter