- 18 Dec 2024
- 4 Minutes to read
- Print
- DarkLight
/Endpoint/rest/api/v1/User/{Id}/Group
- Updated on 18 Dec 2024
- 4 Minutes to read
- Print
- DarkLight
Use the GroupPost
object resource to insert or update (Upsert) Group
using Id, UserId.Email, UserId.Username
field(s) value.
You can supply the required field values in the request data, and then use the POST
method of the resource.
The input parameter must be used in the GroupData
record structure inside the FieldType
parameter in the foreign key fields.
Foreign key fields are: User_Id, Group_Id
Update a record of Group
- If the
Id
field value is not matched, then a404
error is reported (Errors/Not Found
), and the error record is returned.. You cannot changeId
field value (primary key). - If the
UserId.Email, UserId.Username
field value is not empty andId
field value is empty, action try insert record accordingUserId.Email, UserId.Username
field value (if set, the value is a unique identifier).
Create a new record of Group
- If the value in the
UserId.Email, UserId.Username
andId
fields are empty then action insert a new record according input parameter entity record structure (GroupData
).
The response body will contain the object of the updated or created record if the call is successful. Method returns an extended Group
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.
oAuth autentication flow
The identifier of the User 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
Group
information to insert or update.
The input parameter must be used in the GroupData
record structure inside the FieldType
parameter in the foreign key fields.
The record of Group information.
The field object structure. This structure allows users to specify any related entity field and its corresponding value. When saving data, the system automatically retrieves and assigns the primary key value from the system database table based on the provided field name and value.
The name of the data field. This can be any field name from the related database table, such as 'Email' from the User table or 'Name' from the Department table.
The value corresponding to the specified data field. This value is used to identify the record in the related database table. For example, it could be an email address, a department name, or an external system's identifier.
Inserted or updated Group
information.
The record of Group information.
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.