CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/roles:read (Post)
Post/projects/{projectId}/roles:read
Description
Gets an array of role objects that satisfy the filter criteria specified in the request body.
Parameters
NameDescriptionData Type
the id of the projectstring
Request (application/json)

The request body is of type object.

Overview

Filters : RoleFilters
RoleID : string
limit : integer
skip : integer
200 Response

The response body is of type RolesGetResponse.

The collection of roles that satisfy the query.

Overview

RolesGetResponse
The results of the roles get query.
Roles : Array[CimRole]
Alarms : boolean
Classes : boolean
Clients : boolean
DatabaseLogging : boolean
Devices : boolean
GlobalParameters : boolean
Objects : boolean
Points : boolean
Ports : boolean
Projects : boolean
RemoteProjects : boolean
Resources : boolean
Roles : boolean
Users : boolean
WebConfigEnable : boolean
Workbench : boolean
Privileges : CimPrivileges
ChangeApprovalVerify : boolean
DeleteAlarms : boolean
DisableOrModifyAlarms : boolean
DynamicConfiguration : boolean
ModifyAlarmSetups : boolean
ModifyAttributes : boolean
OPCUAServerAdmin : boolean
PointByAddress : boolean
PointTarget : boolean
ProcessControl : boolean
RightClickMenu : boolean
ScriptControl : boolean
SetPoint : boolean
SetpointAuditTrail : boolean
StartProject : boolean
StopProject : boolean
TriggerEvents : boolean
Level : integer
RoleID : string
Fault Responses
FaultDescription
This fault returns a response body of type ProblemDetails.
project with the given id is not registered on the system
Remarks
Returns JSON containing an array of CIMPLICITY role objects
See Also