The Table API allows you to perform the create, read, update, and delete (CRUD) operations on the existing tables.
CRUD requests to the Table API are executed according to the ACL rules.
Table API URL format:
| Name | Value |
|---|---|
| Default URL | /rest/v1/table/ |
Authorization
Two types of Table API request authorization are supported:
- Basic Auth – authentication involves sending a verified username and password with the request.
- Bearer Token – authentication with an access key. The token is a text string, included in the request header.
CREATE operations
Use the POST method to insert one record into the defined table. It does not support insertion of multiple records.
Example:
POST /rest/v1/table/{tableName}
Body parameter
You can specify as many columns and their values as you need.
| Parameter | Value |
|---|---|
| column_name | column_value |
You can use the following parameters with this method:
| Parameter | Description |
|---|---|
| sysparm_display_value | An operation method for data retrieval. It may return both types of values.
Default value: 0. |
| sysparm_exclude_reference_link | A flag indicating whether to exclude the Table API links (/rest/v1/table/) for reference fields.Valid values:
Default value: 0. |
| sysparm_fields | A comma-separated list of fields to return to the response. Value example: number,caller. |
| sysparm_view | The response contains the fields of the form view defined by this parameter. Note that it can be overridden by sysparm_fields. Default value: Default. |
You need to use raw JSON type of Body instead of form-data.
Example:
POST /rest/v1/table/task HTTP/1.1
Host: sandbox-01.dev.simpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
Content-Type: application/json
Content-Length: 43
{
"subject": "Task created by REST"
}
READ operations
Read operations in SimpleOne are limited to the GET method. Depending on whether you need to retrieve a single record or some of them, follow the examples below:
To retrieve a single record from the specified table:
GET /rest/v1/table/{tableName}/{sys_id}
To retrieve multiple record query from the specified table:
GET /rest/v1/table/{tableName}
You can use the following parameters with this method:
| Parameter | Description |
|---|---|
| sysparm_query | An encoded query string used to filter the results. Value example: active=1. |
| sysparm_display_value | An operation method for data retrieval. It may return both types of values.
Default value: 0. |
| sysparm_exclude_reference_link | A flag indicating whether to exclude Table API links (/rest/v1/table/) for reference fields.Valid values:
Default value: 0. |
| sysparm_fields | A comma-separated list of fields to return to the response. Value example: number,caller. |
| sysparm_view | The response contains the fields of the form view defined by this parameter. Note that it can be overridden by sysparm_fields. Default value: Default. |
| sysparm_limit | The maximum number of results returned by query. Default value: 20. |
| sysparm_page | Define the page number to start reading from. For example, if sysparm_limit is set to 40, and you set sysparm_page to 2, the response will include records from 21 to 60. Default value: 1. |
Use raw JSON type of Body instead of form-data.
GET /rest/v1/table/task?sysparm_query=active=1&sysparm_fields=number,caller&sysparm_limit=1&sysparm_exclude_reference_link=1 HTTP/1.1 Host: sandbox-01.dev.simpleone.ru Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
UPDATE operations
There are two methods available for the UPDATE operations: PUT and PATCH. PUT contains new versions of records. Whereas in PATCH, nested objects contain a set of instructions that describe how records on the origin server should be updated to create new versions.
Body parameter
You can specify as many columns and their values as you need.
| Parameter | Value |
|---|---|
| column_name | column_value |
Use raw JSON type of Body instead of form-data.
You can use the following parameters for the PUT and PATCH methods:
| Parameter | Description |
|---|---|
| sysparm_display_value | An operation method for data retrieval. It may return both types of values.
Default value: 0. |
| sysparm_exclude_reference_link | A flag indicating whether to exclude Table API links (/rest/v1/table/) for reference fields.Valid values:
Default value: 0. |
| sysparm_fields | A comma-separated list of fields to return to the response. Value example: number,caller. |
| sysparm_view | The response contains the fields of the form view defined by this parameter. Note that it can be overridden by sysparm_fields. Default value: Default. |
PUT
Use it to update records in the specified table using the values defined in the request body.
Example:
PUT /rest/v1/table/{tableName}/{sys_id}
PATCH
Use it to partially update records. This method updates a specified record with the request body in the specified table.
Example:
PATCH /rest/v1/table/{tableName}/{sys_id}
Example:
PUT /rest/v1/table/task/166032552604350116 HTTP/1.1
Host: sandbox-01.dev.simpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
Content-Type: application/json
Content-Length: 20
{
"state": "3"
}
DELETE operations
Use this method to delete a specified record with the request body from the specified table.
Example:
DELETE /rest/v1/table/{tableName}/{sys_id}
There are two possible responses:
- When a record was successfully deleted.
- When an error occurred.
Example:
DELETE /rest/v1/table/sys_filter/166039918402151705 HTTP/1.1 Host: sandbox-01.dev.simpleone.ru Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
Success response
{
"status": "OK",
"data": {
"description": "Records successfully deleted."
}
Error response
{
"status": "ERROR",
"error_type": "SERVER",
"errors": [
{
"message": "You have no access to delete this records."
}
]
}
3 Comments
editor
editor
editor