REST API

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	??????

POST /v1/table/{essence}
Inserts one record in the specified table. Multiple records insertion is not supported.

Parameter	Value
column_name	column_value

POST

{
...
<column_name> => <column_value>
...
}

GET /v1/table/record/{essence}
Retrieves multiple records for the essence table.

GET /v1/table/record/{essence}/{sys_id}
Retrieves one record from the essence table.

PUT /v1/table/{essence}/{sys_id}
Updates the value for the sys_id field in the essence table.

PATCH /v1/table/{essence}/{sys_id}
Updates the value for the sys_id field in the essence table.

Parameter	Value
column_name	column_value

PATCH

{
...
<column_name> => <column_value>
...
}

DELETE /v1/table/{essence}/{sys_id}
Deletes the value from the sys_id field in the essence table.

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. TRUE: returns field display values; FALSE: returns actual values; Default: FALSE
sysparm_exclude_reference_link	Flag that indicates whether to exclude Table API links for reference fields. Valid values: TRUE: exclude Table API links for reference fields. FALSE: include Table API links for reference fields. 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.

Page tree