SaveData end point allows you to create, update or save a single record in Aptify. The POST action is used for the data modification operations.
In order to save and receive entity record, the AptifyAuthorization header is required along with <TokenId> genrated after Authentication.
| Header Name | Header Value |
|---|
| AptifyAuthorization | <Authentication Provider> <TokenId> |
Endpoint Example
| Code Block |
|---|
|
https://<base address>/services/BasicGenericEntity/SaveData/{id} |
...
- Data: Json data to be save along with Entity Name and ID, if have Sub type then its should be under SubType Tag along with Name as root.
- Id: Optional value need to pass any integer value, this value is not related to data.
Request Body For Non-SubType Record
(POST, as Form Data)| Code Block |
|---|
| title | Sample Request Body For for Non-SubType Record |
|---|
|
{
ID: -1,
EntityName: "Groups",
Name: "Data Savers"
} |
Data returned has a valid ID value, indicating that you successfully saved a new group.Note the ID of the group you created.In this case ID is 1038.
Sample Response Body
| Code Block |
|---|
| title | Sample Response Body For for Non-SubType RecordsRecord |
|---|
|
{
"ID": 1038,
"EntityName": "Groups",
"Name": "Data Savers",
"Description": "",
"Subtypes": [ ]
} |
Request Body For Single SubType Record
(POST, as Form Data)| Code Block |
|---|
| title | Sample Request Body For for Single SubType Record |
|---|
|
{
ID: <Group ID>,
EntityName: "Groups",
SubTypes:
[ {
ID: -1,
EntityName: "GroupMembers",
UserID: <User ID>
} ]
} |
Sample Response Body| Code Block |
|---|
| title | Sample Response Body For for Single SubType Record |
|---|
|
{
"id": <Group ID>,
"entityname": "Groups",
"name": "Data Savers",
"description": "",
"subtypes": [{
"id": <ID>,
"entityname": "GroupMembers",
"groupid": <Group ID>,
"sequence": 1,
"userid": <User ID>,
"userid_name": <User ID Name>,
"aptify_record_version": "system.byte[]"
]}
}
|
Request Body For Multiple SubType Records
(POST, as Form Data) | Code Block |
|---|
| title | Sample Request Body For for Multiple SubType RecordRecords |
|---|
|
{
ID: <Group ID>,
EntityName: "Groups",
SubTypes: [
{
ID: -1,
EntityName: "GroupMembers",
UserID: <User ID 1>
},
{
ID: -1,
EntityName: "GroupMembers",
UserID: <User ID 2>
}
] } |
Sample Response Body| Code Block |
|---|
| title | Sample Response Body For for Multiple SubType RecordRecords |
|---|
|
{
"id": <Group ID>,
"entityname": "Groups",
"name": "Data Savers",
"description": "",
"subtypes": [{
"id": <ID>,
"entityname": "GroupMembers",
"groupid": <Group ID>,
"sequence": 1,
"userid": <User ID 1>,
"userid_name": <User ID1 Name>,
"aptify_record_version": "system.byte[]"
},
{
"id": <ID>,
"entityname": "GroupMembers",
"groupid": <Group ID>,
"sequence": 2,
"userid": <User ID 2>,
"userid_name": <User ID2 Name>,
"aptify_record_version": "system.byte[]"
}]
}
|
HTTP Status Codes
| Status Code | Meaning |
|---|
| 200 | OK; View data in response body |
| 404 | Not Found or Not Authenticated |