Role - Creates a new role

PreviousRole - Retrieves roles from the system NextRole - Updates an existing role

Last updated 6 months ago

Creates a new role using the provided Role Model schema.

post

Authorizations

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Body

Class for representing the view of role.

roleNamestring | nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the RoleName property.

canCreatebooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanCreate property.

canEditbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanEdit property.

canExportbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanExport property.

canViewbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the CanView property.

Responses

201

Success: New role created successfully.

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

409

Conflict: Indicates the existence of a conflicting resource.

500

Internal Server Error: An unexpected error occurred or a server timeout.

post

POST /roles HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "roleName": "text",
  "canCreate": true,
  "canEdit": true,
  "canExport": true,
  "canView": true
}

{
  "roleId": "123e4567-e89b-12d3-a456-426614174000",
  "roleName": "text",
  "canCreate": true,
  "canEdit": true,
  "canExport": true,
  "canView": true,
  "isEditable": true
}