/Endpoint/rest/api/v1/Role/{Id}
- 18 Dec 2024
- 6 Minutes to read
- Print
- DarkLight
/Endpoint/rest/api/v1/Role/{Id}
- Updated on 18 Dec 2024
- 6 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/Endpoint/rest/api/v1/Role/{Id}
The method returns one record of the Role.
Method returns an extended Role structure. Here, all foreign key fields are abstract object structures, utilizing AbstractText or AbstractLong data types, offering a detailed view of the data and related entities.
Foreign key fields are: AccessApplicationId, RoleId, ApplicationId, EspaceId, ModifiedBy, CreatedBy
Get a record of Role
- If the
Idfield value is not matched, then a404error is reported (Errors/Not Found), and the error record is returned. - If the
Idfield value is matched multiple times, then a400error is reported (Errors/Multible Rows), and the error record is returned. - If the
Id, Name, RoleKeyfield value is matched multiple times, then a400error is reported (Errors/Multible Rows), and the error record is returned.
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.
Path parameters
Id
stringRequired
The identifier of the Role record. The parameter is part of the url address and some special characters are forbidden.
You can extract any string to a base64 string. E.g email address name@domain.com value is base64|bmFtZUBkb21haW4uY29t
Query parameters
Name
string
The name of the database field. If empty, the entity Id field is used.
Example:
Name, RoleKey
Responses
200
The record of Role information
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?
