/Endpoint/rest/api/v1/Roles
- 18 Dec 2024
- 8 Minutes to read
- Print
- DarkLight
/Endpoint/rest/api/v1/Roles
- Updated on 18 Dec 2024
- 8 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/Endpoint/rest/api/v1/Roles
Utilize this method to execute a query designed to fetch comprehensive information, delivering all results in a singular response. If necessary, the method returns a portion of the results along with an identifier to retrieve the remaining data.
Leverage the search service to extract the requisite information from the system effectively.
The method returns a list structured with an extended Role representation. In this format, all foreign key fields are depicted as abstract object structures, employing AbstractText or AbstractLong data types. This offers an enriched and detailed perspective of the data and its associated entities.
The foreign key fields involved are: AccessApplicationId, RoleId, ApplicationId, EspaceId, ModifiedBy, CreatedBy
Example
It searches for employees whose data has been modified since January 1, 2022, and belong to departments with external system identifiers DE001 and DE002. The system responds by returning the name, external identifier, and email address of the relevant employees. The retrieved information is organized in ascending order by the person's name, and a limit is set to return a maximum of 1000 rows.
fields=Name,ExternalId,Email&Filters=(DepartmentId.ExternalId In DE001;DE002) AND (ModifiedOn > 2022-01-01)&Orders=Name ASC&PageSize=1000
Security
OAuth
oAuth autentication flow
FlowClient Credentials
Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
Scopes:
AccessManager:ReadAllows to edit access groups and all related data. (ABAC) permissions required to perform a function.
Query parameters
Fields
string
Specify the fields you want to retrieve in the fields parameter and use the GET method of the resource.
The list of database column attributes. If list is empty or "*" then all of fields will be returned.
This method converts a string list to a string with a comma separator.
Example:
Id, Name, RoleKey, FullName, Description, ExternalId, AccessApplicationId, Is_Active, ModifiedOn, ModifiedBy, CreatedBy, CreatedOn
Filters
string
In the List methods, filtering of resources can be performed using filter parameters.
You can also use parent tables as a search filter. For example, the Employee table has a DepartmentId field, so you can search for a department name using the DepartmentId.Name field name. All fields in the parent table are available.
The name of the entity field. Example: Name or relation field OwnerId.Name
Please refer to the corresponding method's documentation for the complete list of supported filter parameters by record.
The operator must be a standard comparison operator =, <>, >, >=, <, <=, In, Like, NotIn
You can add multiple values separated by comma when using the In, NotIn operators. Example of text field; USA; FIN; ARE Example of numeric field; 1, 2, 3
Example of filters:
Filters=(DepartmentId.Name = My Department) AND (DepartmentId.CreatedOn = 2021-01-01)
Filters=(DepartmentId.Name = My Department 1) OR (DepartmentId.ExternalId In DE001;DE002)
Filters=ExternalId In S100;S101;S120;100
Filters=Id = 100
Orders
string
The Orders parameter is provided for sorting the result in the desired order. Both the attribute based on which sorting needs to be done, and the order of sorting (ascending or descending) can be specified. This method converts a string list to a string with a comma separator.
Example:
Name DESC, CreatedOn ASC
CurrentPage
integer (int32)
This field specifies the current page of results being returned. It's often used in conjunction with PageSize to manage pagination by indicating which subset of the total data is currently being retrieved.
Default0
PageSize
integer (int32)
The field indicates the number of items returned in a single page or response. It helps clients determine how many items to display per page and how to request additional pages if needed.
The value ranges from 1 to 1000 and defaults to 50.
Default0
Responses
200
The list of Roles
object
The list of Role records
Meta
object (Meta)
The object provides metadata about the list of items returned in the API response. It typically includes information that helps clients understand and work with the data.
TotalItems
integer (int32)
This field represents the total number of items available in the entire dataset, not just the items returned in the current response. It's useful for implementing pagination, as clients can use it to calculate the number of pages or total available items.
Default0
Example1000
CurrentPage
integer (int32)
This field specifies the current page of results being returned. It's often used in conjunction with PageSize to manage pagination by indicating which subset of the total data is currently being retrieved.
Default1
Example50
PageSize
integer (int32)
The field indicates the number of items returned in a single page or response. It helps clients determine how many items to display per page and how to request additional pages if needed.
Default50
Example50
Type
string
The type of the record
ExampleUser
Data
Array of object (Role1)
The list of Role records
object
The record of Role information.
Id
string
The identifier of the role
Name
string
Name of role
RoleKey
string
The key used to identify the role must be unique within each workspace.
FullName
string
Full name of role. Example Application 1 \ Espace 1 \ Role 1
Description
string
The description of access group
ExternalId
string
The external system code of the role
AccessApplicationId
object (AbstractText)
This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.
Id
string
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
ExternalId
string
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
Name
string
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
ExampleBob Normal
Type
string
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
ExampleUser
Is_Active
boolean
Defines if record is active
Defaultfalse
ExampleFalse
ModifiedOn
string (date-time)
The date the record was updated
Default"1900-01-01T12:00:00Z"
Example1900-01-01T12:00:00Z
ModifiedBy
object (AbstractLong)
This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.
Id
integer (int64)
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
Default0
Example1234567891234567
ExternalId
string
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
Name
string
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
ExampleBob Normal
Type
string
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
ExampleUser
CreatedBy
object (AbstractLong)
This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.
Id
integer (int64)
The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.
Default0
Example1234567891234567
ExternalId
string
An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.
Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
Name
string
The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.
ExampleBob Normal
Type
string
The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.
ExampleUser
CreatedOn
string (date-time)
The date the record was created
Default"1900-01-01T12:00:00Z"
Example1900-01-01T12:00:00Z
400
Bad Request - The user has provided input that the browser is unable to convert.
{
"Errors": [
"The user has provided input that the browser is unable to convert.",
"There are multiple rows in the database for the same value",
"The value does not match the specified entity structure",
"..."
],
"Type": "/Errors/Bad Input",
"Title": "Bad Request",
"StatusCode": 400,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}object
The list of errors. Throw specific exceptions based on the received error.
Errors
Array of string
Human-readable explanation of the errors
string
Default""
Type
string
URI identifier that categorizes the error
Default""
Title
string
Brief, human-readable message about the error
Default""
StatusCode
integer (int32)
The HTTP response code
Example400
Instance
string
URI that identifies the specific occurrence of the error
Default""
RequestKey
string
Provides a request key that identifies the current request.
Default""
401
Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.
{
"Errors": [
"The session Id or OAuth token used has expired or is invalid."
],
"Type": "/Errors/Unauthorized",
"Title": "Unauthorized",
"StatusCode": 401,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}object
The list of errors. Throw specific exceptions based on the received error.
Errors
Array of string
Human-readable explanation of the errors
string
Default""
Type
string
URI identifier that categorizes the error
Default""
Title
string
Brief, human-readable message about the error
Default""
StatusCode
integer (int32)
The HTTP response code
Example400
Instance
string
URI that identifies the specific occurrence of the error
Default""
RequestKey
string
Provides a request key that identifies the current request.
Default""
403
Forbidden - The user does not have access to execute operation
{
"Errors": [
"The user does not have access to execute operation"
],
"Type": "/Errors/Permission",
"Title": "Bad Request",
"StatusCode": 403,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}object
The list of errors. Throw specific exceptions based on the received error.
Errors
Array of string
Human-readable explanation of the errors
string
Default""
Type
string
URI identifier that categorizes the error
Default""
Title
string
Brief, human-readable message about the error
Default""
StatusCode
integer (int32)
The HTTP response code
Example400
Instance
string
URI that identifies the specific occurrence of the error
Default""
RequestKey
string
Provides a request key that identifies the current request.
Default""
500
Internal Server Error - An internal server error is an error on the web server you're trying to access.
{
"Errors": [
"An internal server error is an error on the web server you're trying to access."
],
"Type": "/Errors/Internal Server Error",
"Title": "Internal Server Error",
"StatusCode": 500,
"Instance": "/OpenApi/rest/Xzy",
"RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}object
The list of errors. Throw specific exceptions based on the received error.
Errors
Array of string
Human-readable explanation of the errors
string
Default""
Type
string
URI identifier that categorizes the error
Default""
Title
string
Brief, human-readable message about the error
Default""
StatusCode
integer (int32)
The HTTP response code
Example400
Instance
string
URI that identifies the specific occurrence of the error
Default""
RequestKey
string
Provides a request key that identifies the current request.
Default""
Was this article helpful?
