Page History

The REST 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

CREATE operations

POST

/rest/v1/table/

{essence}

This method allows inserting one record in the defined table. It does not support multiple records insertion.

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.

Image Added

CREATE operations

Use the POST method to insert one record into the defined table. It does not support insertion of multiple records.

Example:

Code Block
POST

Parameters

ParameterValuecolumn_namecolumn_value

Code Block

language	php
theme	Eclipse
title	POST

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

READ operations

GET

/rest/v1/table/{

essence

tableName}

This method returns multiple records for the essence table.

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:

GET /rest/v1/table/{essence}/{sys_id}
This method retrieves one record from the essence table.

UPDATE operations

PUT /rest/v1/table/{essence}/{sys_id}
This method updates the specified record with the request body in the essence table.

PATCH

Parameter

Description

sysparm_display_value

An operation method for data retrieval. It may return both types of values.

1 – returns field display values.
0 – returns database field values.

Default value: 0.

sysparm_exclude_reference_link

A flag indicating whether to exclude the Table API links (

/rest/v1/table/

{essence}/{sys_id}

This method updates the specified record with the request body in the essence table.

Parameters

ParameterValuecolumn_namecolumn_value

Code Block

language	php
theme	Eclipse
title	PATCH

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

DELETE operations

DELETE /rest/v1/table/{essence}/{sys_id}
Deletes the specified record with the request body from the essence table.

ParametersNameDescriptionSupported CRUD operationssysparm_queryAn encoded query string used to filter the results.Rsysparm_display_value

Data retrieval operation method. Also, may return both types of values.

TRUE: returns field display values.
FALSE: returns actual values.

Default: FALSE

CRUsysparm_exclude_reference_linkFlag 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

CRU

) for reference fields.

Valid values:

1 – exclude Table API links for reference fields.
0 – include Table API links for reference fields.

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.

Note
You need to use raw JSON type of Body instead of form-data.

Example:

Image Added

Section

Code Block

language	js
theme	Eclipse
title	HTTP
linenumbers	true

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"
}

Code Block

language	js
theme	Confluence
title	Response
linenumbers	true
collapse	true

sysparm_fieldsA comma-separated list of fields to return in the response.CRUsysparm_viewRender the response according to the specified UI view (overridden by sysparm_fields).CRUsysparm_limit

The maximum number of results returned per page.

This parameter is equal to the self::CRUD_API_LIMIT_RECORDS.

Default = 20 (for GET-queries).

Rsysparm_page

Page number to offset records.

Default = 1.

Code Examples

Image Removed

Code Block

language	xml
theme	Confluence
title	sysparm_limit
collapse	true

{

  "status": "OK",

"data": [

"sys_id":

156016554400838540

"166031411802010329",
      "state": "7",
      "

parent_id

priority": null,
      "urgency": null,
      "

sys_updated_at

impact":

"2019-06-10 11:19:04"

null,
      "assigned_user": null,
      "

impact

assignment_group": null,
      "wf_executing_activity": null,
      "

number

closed_by":

"TSK002930"

null,
      "followers_list": null,
      "

sys

parent_

created_at

id":

"2019-06-10 11:19:04",

null,
      "

assigned

opened_

user

by":

{

null,
      "caller": {

"value": "

155964310500000018

155931135900000001",

        "link": "

https

http://

your-instance-address.com

sandbox-01.dev.simpleone.ru/rest/v1/table/user/

155964310500000018

155931135900000001"

},

sys_updated_by

contact":

{

null,

"service": null,

value

screenshot":

"155964310500000018"

null,

"link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"

"short_description": null,

},

"work_notes": null,
      "active":

null

true,

opened

closed_at": null,

"contact

"sla_due":

{

null,
      "sys_updated_at":

"2022-08-12 14:21:58",
      "

value

sys_created_at": "2022-08-12 14:21:58",

"description": null,
      "

link

number": "

https://your-instance-address.com/rest/v1/table/user/"

TSK0000006",
      "subject": "Task created by

}

REST",
      "additional_comments": null,
      "

sys_created_by

comments":

{

null,

"opened_at": "2022-08-12 14:21:58",

value

due_date":

"155964310500000018"

null,

link

attention_required":

"https://your-instance-address.com/rest/v1/table/user/155964310500000018"

false,

},

"company": null,

closed

approval_

at

state":

null

"not_requested",
      "sys_db_table_id": "155931135900000083",
      "display_name": "

TSK002930 1

TSK0000006 Task created by REST",

steps

sys_

to

updated_

reproduce

by":

null,

priority

value":

null

"155931135900000001",

screenshot

link":

null,

"http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
      },
      "

attention

sys_created_

required

by":

false,

"assignment_group": null, "watcher_list

: { "

value": "155931135900000001",

        "link": "

https

http://

your-instance-address.com

sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"

}
    }

, "company": null, "work_notes": null, "additional_comments": null, "closed_by": null, "opened_by": null, "due_date": null, "sys_db_table_id": 155964310500000025, "urgency": null, "policy": "Open", "total_points": 0, "burned_points": null, "caller": null, "state": 7, "description": null, "subject": "1" }, { "sys_id": 155964310500002012, "parent_id": null, "sys_updated_at": "2019-06-18 15:28:32", "impact": null, "number": "TSK002836", "sys_created_at": "2019-02-19 14:30:19",

]
}

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:

Code Block
GET /rest/v1/table/{tableName}/{sys_id}

To retrieve multiple record query from the specified table:

Code Block
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. 1 – returns field display values. 0 – returns database field 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: 1 – exclude Table API links for reference fields. 0 – include Table API links for reference fields. 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.

Note
Use raw JSON type of Body instead of form-data.

Image Added

Section

Code Block

language	js
theme	Eclipse
title	HTTP
linenumbers	true

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

Code Block

language	js
theme	Confluence
title	Response
linenumbers	true
collapse	true

{
    "status": "OK",
    "data": [
        {
            "

assigned_user

number":

null

"TSK0000006",
            "

sys_updated_by

caller":

{

155931135900000001
        }

"value": "155964310500000018", "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018" }, "active": true, "opened_at": null, "contact": { "value": "", "link": "https://your-instance-address.com/rest/v1/table/user/" }, "sys_created_by": { "value": "155964310500000026", "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000026" }, "closed_at": null, "display_name": "TSK002836 ", "steps_to_reproduce": null, "priority": null, "screenshot": null, "attention_required": null, "assignment_group": null, "watcher_list": null, "company": null, "work_notes": null, "additional_comments": null, "closed_by": null, "opened_by": null, "due_date": null, "sys_db_table_id": 155964310500000025, "urgency": null, "policy": "Changed", "total_points": null, "burned_points": null, "caller": null, "state": 1, "description": "", "subject": "" } ] }

Code Block

language	xml
theme	Confluence
title	sysparm_page
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": 156016554400838540,
            "parent_id": null,
            "sys_updated_at": "2019-06-10 11:19:04",
            "impact": null,
            "number": "TSK002930",
            "sys_created_at": "2019-06-10 11:19:04",
            "assigned_user": {
                "value": "155964310500000018",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "sys_updated_by": {
                "value": "155964310500000018",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "active": null,
            "opened_at": null,
            "contact": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "sys_created_by": {
                "value": "155964310500000018",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "closed_at": null,
            "display_name": "TSK002930 1",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": false,
            "assignment_group": null,
            "watcher_list": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Open",
            "total_points": 0,
            "burned_points": null,
            "caller": null,
            "state": 7,
            "description": null,
            "subject": "1"
        }
    ]
}

Image Removed

Code Block

language	xml
title	sysparm_fields
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": 155981791201907166,
            "parent_id": null,
            "sys_updated_at": "2019-06-06 10:45:13",
            "impact": null,
            "number": "TSK002918",
            "sys_created_at": "2019-06-06 10:45:13",
            "assigned_user": null,
            "sys_updated_by": {
                "value": "155964310500000018",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "active": null,
            "opened_at": null,
            "contact": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "sys_created_by": {
                "value": "155964310500000018",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "closed_at": null,
            "display_name": "TSK002918 1",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": false,
            "assignment_group": null,
            "watcher_list": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Open",
            "total_points": 0,
            "burned_points": null,
            "caller": null,
            "state": 7,
            "description": null,
            "subject": "1"
        }
    ]
}

Image Removed

Code Block

language	xml
theme	Confluence
title	sysparm_fields
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": 155981791201907166,
            "parent_id": null,
            "sys_updated_at": "2019-06-06 10:45:13",
            "impact": null,
            "number": "TSK002918",
            "sys_created_at": "2019-06-06 10:45:13",
            "assigned_user": null,
            "sys_updated_by": "155964310500000018",
            "active": null,
            "opened_at": null,
            "contact": "",
            "sys_created_by": "155964310500000018",
            "closed_at": null,
            "display_name": "TSK002918 1",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": false,
            "assignment_group": null,
            "watcher_list": "",
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Open",
            "total_points": 0,
            "burned_points": null,
            "caller": null,
            "state": 7,
            "description": null,
            "subject": "1"
        }
    ]
}

Image Removed

Code Block

language	xml
theme	Confluence
title	sysparm_display_value
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": 156016554400838540,
            "parent_id": null,
            "sys_updated_at": "2019-06-10 11:19:04",
            "impact": null,
            "number": "TSK002930",
            "sys_created_at": "2019-06-10 11:19:04",
            "assigned_user": {
                "value": "Jane Doe",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "sys_updated_by": {
                "value": "Jane Doe",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "active": null,
            "opened_at": null,
            "contact": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "sys_created_by": {
                "value": "Jane Doe",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "closed_at": null,
            "display_name": "TSK002930 1",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": false,
            "assignment_group": null,
            "watcher_list": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Open",
            "total_points": 0,
            "burned_points": null,
            "caller": null,
            "state": "Completed",
            "description": null,
            "subject": "1"
        },
        {
            "sys_id": 155964310500002012,
            "parent_id": null,
            "sys_updated_at": "2019-06-18 15:28:32",
            "impact": null,
            "number": "TSK002836",
            "sys_created_at": "2019-02-19 14:30:19",
            "assigned_user": null,
            "sys_updated_by": {
                "value": "Jane Doe",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "active": true,
            "opened_at": null,
            "contact": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "sys_created_by": {
                "value": "John Doe",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000026"
            },
            "closed_at": null,
            "display_name": "TSK002836 ",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": null,
            "assignment_group": null,
            "watcher_list": null,
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Changed",
            "total_points": null,
            "burned_points": null,
            "caller": null,
            "state": "Scheduled",
            "description": "",
            "subject": ""
        }
    ]
}

Image Removed

Code Block

language	xml
title	sysparm_exclude_reference_link
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": 155981791201907166,
            "parent_id": null,
            "sys_updated_at": "2019-06-06 10:45:13",
            "impact": null,
            "number": "TSK002918",
            "sys_created_at": "2019-06-06 10:45:13",
            "assigned_user": null,
            "sys_updated_by": "Jane Doe",
            "active": null,
            "opened_at": null,
            "contact": "",
            "sys_created_by": "Jane Doe",
            "closed_at": null,
            "display_name": "TSK002918 1",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": false,
            "assignment_group": null,
            "watcher_list": "",
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Open",
            "total_points": 0,
            "burned_points": null,
            "caller": null,
            "state": "Completed",
            "description": null,
            "subject": "1"
        },
        {
            "sys_id": 155983188102317352,
            "parent_id": null,
            "sys_updated_at": "2019-06-06 14:38:01",
            "impact": null,
            "number": "TSK002926",
            "sys_created_at": "2019-06-06 14:38:01",
            "assigned_user": null,
            "sys_updated_by": "Jane Doe",
            "active": null,
            "opened_at": null,
            "contact": "",
            "sys_created_by": "Jane Doe",
            "closed_at": null,
            "display_name": "TSK002926 1",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": false,
            "assignment_group": null,
            "watcher_list": "",
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Open",
            "total_points": 0,
            "burned_points": null,
            "caller": null,
            "state": "Completed",
            "description": null,
            "subject": "1"
        }
    ]
}

CREATE operations

Image Removed

Code Block

language	xml
theme	Confluence
title	CREATE
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": 156741210205635452,
            "parent_id": null,
            "sys_updated_at": {
                "expression": "NOW()",
                "params": []
            },
            "impact": null,
            "number": "TSK00031",
            "sys_created_at": {
                "expression": "NOW()",
                "params": []
            },
            "assigned_user": null,
            "sys_updated_by": {
                "value": "155964310500000001",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000001"
            },
            "active": null,
            "opened_at": null,
            "contact": null,
            "sys_created_by": {
                "value": "155964310500000001",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000001"
            },
            "closed_at": null,
            "display_name": "TSK00031 test",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": null,
            "assignment_group": null,
            "watcher_list": null,
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Open",
            "total_points": null,
            "burned_points": null,
            "caller": 156636690504223270,
            "state": null,
            "description": null,
            "subject": "test"
        }
    ]
}

UPDATE operations

Image Removed

Code Block

language	xml
theme	Confluence
title	UPDATE
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": 155981791201907166,
            "parent_id": null,
            "sys_updated_at": {
                "expression": "NOW()",
                "params": []
            },
            "impact": null,
            "number": "TSK002918",
            "sys_created_at": "2019-06-06 10:45:13",
            "assigned_user": null,
            "sys_updated_by": {
                "value": "155964310500000001",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000001"
            },
            "active": null,
            "opened_at": null,
            "contact": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "sys_created_by": {
                "value": "155964310500000018",
                "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000018"
            },
            "closed_at": null,
            "display_name": "TSK002918 1",
            "steps_to_reproduce": null,
            "priority": null,
            "screenshot": null,
            "attention_required": false,
            "assignment_group": null,
            "watcher_list": {
                "value": "",
                "link": "https://your-instance-address.com/rest/v1/table/user/"
            },
            "company": null,
            "work_notes": null,
            "additional_comments": null,
            "closed_by": null,
            "opened_by": null,
            "due_date": null,
            "sys_db_table_id": 155964310500000025,
            "urgency": null,
            "policy": "Changed",
            "total_points": 0,
            "burned_points": null,
            "caller": 156636690504223270,
            "state": 7,
            "description": null,
            "subject": "1"
        }
    ]
}

Image Removed

]
}

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

Note
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. 1 – returns field display values. 0 – returns database field 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: 1 – exclude Table API links for reference fields. 0 – include Table API links for reference fields. 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:

Code Block

theme	Eclipse

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:

Code Block
PATCH /rest/v1/table/{tableName}/{sys_id}

Example:

Image Added

Section

Code Block

language	js
theme	Eclipse
title	HTTP
linenumbers	true

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"
}

Code Block

language	js
theme	Confluence
title	Response
linenumbers	true
collapse	true

{
    "status": "OK",
    "data": [
    {
        "sys_id": "166032552604350116",
        "state": "3",
        "priority": null,
        "urgency": null,
        "impact": null,
        "assigned_user": null,
        "assignment_group": null,
        "wf_executing_activity": null,
        "closed_by": null,
        "followers_list": null,
        "parent_id": null,

Code Block

language	xml
theme	Confluence
title	UPDATE
collapse	true

{ "status": "OK", "data": [ { "sys_id": 155983188102317352, "parent_id": null, "sys_updated_at": { "expression": "NOW()", "params": [] }, "impact": null, "number": "TSK002926", "sys_created_at": "2019-06-06 14:38:01", "assigned_user": null, "sys_updated_by": { "value": "155964310500000001", "link": "https://your-instance-address.com/rest/v1/table/user/155964310500000001" }, "active": null,

        "opened_

at

by": null,

"caller":

"contact":

{

    {
            "value": "155931135900000001",

            "link": "

https

http://

your-instance-address.com

sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
        },
        "contact": null,
        "service": null,
        "screenshot": null,

},

   "short_description": null,
        "

sys

work_

created_by

notes":

{

null,
        "active": true,
        "

value

closed_at":

"155964310500000018"

null,
        "sla_due": null,
        "

link

sys_updated_at": "

https://your-instance-address.com/rest/rest/v1/table/user/155964310500000018"

2022-08-13 13:46:11",
        "sys_created_at":

},

"2022-08-12 17:32:06",
        "

closed_at

description": null,
        "number": "TSK0000014",
        "

display_name

subject": "

TSK002926

Kickoff

1

meeting",

steps

additional_

to_reproduce

comments": null,

priority

comments": null,
        "opened_at": "2022-08-12 17:32:06",

"screenshot

     "due_date": null,

        "attention_required": false,

assignment_group

company":

null,

"watcher_list":

"value": "166032365806600708",

            "link": "

https

http://

your-instance-address.com/rest

sandbox-01.dev.simpleone.ru/rest/v1/table/

user

org_company/166032365806600708"

},

company

approval_state":

null, "work_notes": null,

"not_requested",
        "

additional_comments

sys_db_table_id":

null

"155931135900000083",

closed

display_

by

name":

null

 "TSK0000014 Kickoff meeting",

opened

sys_updated_by":

null,

"due_date": null,

{
            "

sys_db_table_id

value":

155964310500000025

"155931135900000001",

"urgency": null,

"link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"

"policy": "Changed"

},

total

sys_created_

points

by":

0,

"burned_points": null,

{
            "

caller

value":

155964310500000002

"155931135900000001",
            "

state

link":

7,

"http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"

"description": null,

   }
    }]
}

DELETE operations

Use this method to delete a specified record with the request body from the specified table.

Example:

Code Block
DELETE /rest/v1/table/{tableName}/{sys_id}

There are two possible responses:

When a record was successfully deleted.
When an error occurred.

Example:

Image Added

Code Block

language	js
theme	Eclipse
title	HTTP
linenumbers	true

DELETE     "subject": "1"
        }
    ]
}

DELETE operations

Image Removed

/rest/v1/table/sys_filter/166039918402151705 HTTP/1.1
Host: sandbox-01.dev.simpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu

Success response

Code Block

language	js
theme	EclipseConfluence
titlelinenumbers	Delete successtrue

{
    "status": "OK",
    "data": {
        "description": "Records successfully deleted."
    }
}

Image RemovedError response

Code Block

language	js
theme	Confluence
titlelinenumbers	Delete failtrue

{
    "status": "ERROR",
    "error_type": "SERVER",
    "errors": [
        {
            "message": "You have no access to delete this records."
        }
    ]
}

Authorization

Image Removed

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 41

New Version Current

Key

Authorization

CREATE operations

Parameters

READ operations

UPDATE operations

Parameters

DELETE operations

Code Examples

READ operations

CREATE operations

UPDATE operations

UPDATE operations

PUT

PATCH

DELETE operations

DELETE operations

Authorization