- 18 Dec 2024
- 4 Minutes to read
- Print
- DarkLight
/Endpoint/rest/api/v1/Role/{Id}/Permission/{SubId}
- Updated on 18 Dec 2024
- 4 Minutes to read
- Print
- DarkLight
Use the query string resource to delete Permission
record. The method contains two parameters SubId
and SubName
. Specify the record SubId
, SubName
using Id, PermissionId
field(s) value and use the DELETE
method of the resource to delete a record.
Method returns an extended Permission
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: AccessRoleId, RoleId, PermissionId
Delete a record of Permission
- If the
Id
field value is not matched, then a404
error is reported (Errors/Not Found
), and the error record is returned. - If the
Id
field value is matched multiple times, then a400
error is reported (Errors/Multible Rows
), and the error record is returned. - If the
Id, PermissionId
field value is matched multiple times, then a400
error is reported (Errors/Multible Rows
), and the error record is returned.
The response body will contain the object of the deleted record if the call is successful.
oAuth autentication flow
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
The identifier of the Permission 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
The name of the database field. If empty, the entity Id
field is used.
Example:
Id
The name of the database field. If empty, the entity Id
field is used.
Example:
PermissionId
Deleted Permission
information.
The record of Permission information.
The identifier of entity
This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.
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.
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.
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.
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.
The date when the record was created.
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"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.
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"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.
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"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.
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"
}
The list of errors. Throw specific exceptions based on the received error.
Human-readable explanation of the errors
URI identifier that categorizes the error
Brief, human-readable message about the error
The HTTP response code
URI that identifies the specific occurrence of the error
Provides a request key that identifies the current request.