Rollen auflisten
Verwenden Sie die Rollen auflisten API, um eine Liste der Rollen in der Datei Control Room. Der Endpunkt unterstützt Paginierung, Sortierung und Filterung.
Anforderung
POST http://{{ControlRoomURL}}/v1/usermanagement/roles/list
Header: X-Authorization <<authentication token>>
Alle API-Aufrufe müssen ein Authentifizierungs-Token in der Kopfzeile der Anfrage enthalten. Verwenden Sie die Authentifizierung API, um ein JSON-Web-Token zu erzeugen. Einzelheiten finden Sie unter Authentifizierungs-API.Anfragekörper ohne Filter:
{
"sort":[
{
"field":"name",
"direction":"asc"
}
],
"filter":{
},
"fields":[
],
"page":{
"offset":0,
"total":100,
"totalFilter":100,
"length":200
}
}
Anfragekörper mit Filtern:
{
"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
}
}
Anforderungsparameter
Parameter | Typ | Erforderlich | Beschreibung |
---|---|---|---|
sortieren | Array | Nein | Standardmäßig werden die Suchergebnisse in absteigender Reihenfolge nach ihren IDs sortiert. Eine alternative Sortierung wird mit dem Abfrageparameter sort angegeben. Geben Sie das Feld ein, nach dem Sie sortieren möchten, sowie die Richtung |
filter | Objekt | Nein | Filtert das Ergebnis. |
fields | Array | Nein | Filtert das Ergebnis anhand der Felder. |
page |