- 22 Oct 2024
- 6 Minutes to read
- Print
- DarkLight
/Endpoint/rest/api/v1/Location/{Id}/Users
- Updated on 22 Oct 2024
- 6 Minutes to read
- Print
- DarkLight
Use the UsersData
object resource to insert or update (Upsert) a list of UserData
using Id
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 UserList
record structure as text fields in the foreign key fields.
Foreign key fields are: LocationId, UserId, ModifiedBy, CreatedBy
Update a record of User
- When the Id field value is not provided, the system will automatically initiate the insertion of a new record.
Attention!, this can also cause an incorrect row update, but at the same time enables efficient data transfer between systems.
Create a new record of User
- If the value in the
Id
field is empty then action insert a new record according input parameter entity record structure (UserData
).
The response body will contain the record list structure of the updated or created record if the call is successful. The method returns a list structured with an extended User
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.
oAuth autentication flow
The identifier of the Location 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 Delete not exists function delete orphan values from a table.
If you specify value, you do not need to manually delete orphan rows from the table, the service retrieves the result set and if it is not found from the json string, then delete orphan rows from the table.
The list of User information to insert or update.
The input parameter must be used in the Extra
record array structure inside the Name
and FieldName
parameters in the foreign key fields.
The data loading record of User importing
List validation for entity attribute
List validation for entity attribute
The name of the entity field.
The field name of relation database table.
Example; The field name is 'TenantId' and is associated with the 'Tenant' table. You want to use in the 'Tenant' table 'Name' field fetching data. Once 'Name' is specified, the validation service retrieves the tenant identifier from the 'Tenant' table based on the 'Name' field.
If True, the value is required.
If True, the value must be unique in the database and you cannot add multiple values.
The max value of input value.
The min value of input value.
The pattern of the validation. Searches the input string for an occurrence of a regular expression.
The default value of row. If the value of the field is empty, the service automatically sets the value in the field. If the value does not match the data type, the value is cleaned. Remember data types.
If the value is true, the data quality of all fields are checked. This has an effect on performance.
The list of User
data record for import
The record of User information.
The identifier of the user who has link the department.
Inserted or updated list of User information.
The list of User
records
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.
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.
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.
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 type of the record
The list of User records
The record of User information.
Unique identifier of the user.
Full name of the user.
Login name of the user.
Email contact of the user.
Mobile phone number of the user.
The user identifier in an external system to the Platform.
The date the user was created.
Last time the user logged in the application.
Indicates if the user is still active.
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.