Role

What can you do with Role?


Properties

Property Details
id
"id": 776
Type: Number
This is the unique numeric identifier for the Role
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 88
Type: Number
Unique identifier for the associated Owner object.
apiAudience
"apiAudience": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • apiAudience

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Role object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/Role/{id:int}
Delete an instance of the Role object.
GETapi/v1/Role
Retrieve all of the Role objects.
GETapi/v1/Role/Metadata
Retrieve all of the meta data details of the Role object.
GETapi/v1/Role/Metadata/{option}
Retrieve all the meta data details of the Role object based on provided options.
{option}Metadata options for the Role object.
GETapi/v1/Role/Paged
Retreive all of the Role objects in a paged fashion.
GETapi/v1/Role/Paged/Detail
Retreive all of the Role objects in a paged fashion with all object details.
GETapi/v1/Role/{id:int}
Retrieve an instance of the Role object by it's ID.
{id:int}Unique identifier for the Role object.
GETapi/v1/Role/{id:int}/Detail
Retreive all of the Detail objects for the specified Role.
{id:int}Unique identifier for the Role object.
GETapi/v1/Role/{id:int}/Permissions/UIScreen/Detail
Retreive all of the Permissions/UIScreen/Detail objects for the specified Role.
{id:int}Unique identifier for the Role object.
PATCHapi/v1/Role/{id:int}
Update the Role object and optionally make changes to any child objects.
POSTapi/v1/Role
Create a new instance of the Role object.
PUTapi/v1/Role/{id:int}
Update an existing instance of the Role object.