Jump to: navigation, search

Query Metadata Roles

Important
Prerequisites: You need to enable profiles in UCS.
GET /metadata/roles/

Description

This method provides convenient access to roles as configured in Configuration Server.

Operation

-
ID CV.WS.SRV.META.x
URI /metadata/roles
Method GET

Response

The Context Management Service API answers with HTTP codes for every request. The following table shows the correct response for a successful request. See HTTP Response Codes and Errors for further details on the possible codes that this operation can return.

Response
HTTP code 200
HTTP message OK
Name   Type   Description
role_name String The name of the given role.
role_dbid String The unique ID of the given role.
role_enabled Boolean
  • enabled
  • disabled
task JSON Array A task is made up of the following:
  • Name--The name of the task.
  • Capability--Indicates whether the role can perform the task.

<references />

Example

The following operation returns the configured roles with the state and capability.

Operation

GET /metadata/roles

Result

On success, the operation returns an array of zero or more JSON objects.

[ {
  "role_DBID" : 108,
  "role_enabled" : true,
  "tasks" : [ {
    "capableOf" : true,
    "name" : "UCS.Customer.createProfile"
  } ],
  "role_name" : "Ucs_BigBrother"
}, {
  "role_DBID" : 110,
  "role_enabled" : true,
  "tasks" : [ {
    "capableOf" : true,
    "name" : "UCS.SchemaMgt.readServiceExtensionSchema"
  }, {
    "capableOf" : true,
    "name" : "UCS.Service.readServiceExtension"
  }, {
    "capableOf" : true,
    "name" : "UCS.Service.createServiceExtension"
  }, {
    "capableOf" : true,
    "name" : "UCS.Service.deleteServiceExtension"
  }, {
    "capableOf" : true,
    "name" : "UCS.SchemaMgt.readTaskExtensionSchema"
  }, {
    "capableOf" : true,
    "name" : "UCS.Service.startService"
  }, {
    "capableOf" : true,
    "name" : "UCS.SystemMgt.readServerInfo"
  }, {
    "capableOf" : true,
   "name" : "UCS.Service.readService"
 }, {
   "capableOf" : true,
    "name" : "UCS.SystemMgt.changeServerMode"
  } ],
  "role_name" : "ucs_roleForAgents"
}, {
  "role_DBID" : 111,
  "role_enabled" : true,
  "tasks" : [ {
    "capableOf" : true,
    "name" : "UCS.SchemaMgt.handleMetadata"
  }, {
    "capableOf" : true,
    "name" : "UCS.SystemMgt.readServerInfo"
  }, {
    "capableOf" : true,
    "name" : "UCS.SchemaMgt.readGenAdminRole"
  } ],
  "role_name" : "uselessRole"
}, {
  "role_DBID" : 112,
  "role_enabled" : true,
  "tasks" : [ {
    "capableOf" : true,
    "name" : "UCS.SystemMgt.readServerInfo"
  } ],
  "role_name" : "anotherUselessRole"
} ]

<references />

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on September 7, 2018, at 02:35.