Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
The REST API allows you to perform create, read, update and delete (CRUD) operations on existing tables.
URL format:
| Name | Value |
|---|---|
| Default URL | rest-api.simpleone.ru |
| Versioned URL | ?????? |
CREATE operations
POST /v1/table/{essence}
Inserts one record in the specified table. Multiple records insertion is not supported.
Parameters
| Parameter | Value |
|---|---|
| column_name | column_value |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
...
<column_name> => <column_value>
...
} |
READ operations
GET /v1/table/record/{essence}Retrieves multiple records for the essence table.
GET /v1/table/record/{essence}/{sys_id}
Retrieves records for the sys_id column of one record from the essence table.
UPDATE operations
PUT /v1/table/{essence}/{sys_id}
Updates values the value for the sys_id column field in the essence table.
PATCH /v1/table/{essence}/{sys_id}
Updates values the value for the sys_id column field in the essence table.
Parameters
| Parameter | Value |
|---|---|
| column_name | column_value |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
...
<column_name> => <column_value>
...
} |
DELETE operations
DELETE /v1/table/{essence}/{sys_id}
Deletes values the value from the sys_id column field in the essence table.
Parameters
| Name | Description |
|---|---|
| sysparm_query | An encoded query string used to filter the results. |
| sysparm_display_value | Data retrieval operation method. Also, may return both types of values.
Default: FALSE |
| sysparm_exclude_reference_link | Flag that indicates whether to exclude Table API links for reference fields. Valid values:
Default: FALSE |
| sysparm_fields | A comma-separated list of fields to return in the response. |
| sysparm_view | Render the response according to the specified UI view (overridden by sysparm_fields). |
| sysparm_limit | The maximum number of results returned per page. This parameter is equal to the self::CRUD_API_LIMIT_RECORDS that can be defined (where). Default = 20 (for GET-queries). |
| sysparm_page | Page number to offset records. Default = 1. |
| Table of Contents | ||||
|---|---|---|---|---|
|