Versions Compared

Old Version 42

changes.mady.by.user Igor Shakhbazyan

Saved on

compared with

New Version 43

changes.mady.by.user Dina Baksheeva

Saved on

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:

NameValue
Default URL/rest/v1

Authorization

In SimpeOne, three types of authorization are supported:

  • No Auth – request does not require authorization.
  • 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

POST /rest/v1/table/{essencetableName}

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

Parameters

ParameterNameValueDescription
columnsysparm_namecolumndisplay_value
Code Block
languagephp
themeEclipse
titlePOST
{
...
<column_name> => <column_value>
...
}

READ operations

GET /rest/v1/table/{essence}

This method returns multiple records for the essence table.

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

  • true – returns field display values.
  • false – returns actual values.

Default value: false.

sysparm_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 value: false.

sysparm_fields

A comma-separated list of fields to return to the response.

Value example: username,email.

sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

Value example: SP.


Body parameter

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 /rest/v1/table/{essence}/{sys_id}

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

Parameters

ParameterValue
column_namecolumn_value


Note

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


php
Section


Code Block
language
js
themeEclipse
title
PATCH
{
...
<column_name> => <column_value>
...
}

DELETE operations

DELETE
Code Snippet
linenumberstrue
POST /rest/v1/table/
{essence}/{sys_id}

Deletes the specified record with the request body from the essence table.

Parameters
dashboard HTTP/1.1
Host: your-instance.example.ru
Content-Type: application/json
Authorization: Basic am91bi5kb4U6MTIzNDU2Nzg6
Cookie: SERVERID=srv-ocXctExSS6esqqmrg3ZkKA|Wqnmc
Content-Length: 141

 {  
            "name": "My Dashboard",              
            "description":"Some description",
            "refresh_time": "300"  
 }


Code Block
languagejs
themeConfluence
titleResponse
linenumberstrue
collapsetrue
NameDescriptionSupported 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

CRUsysparm_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

true
Code Block
languagexml
themeConfluence
titlesysparm_limit
collapse
{
    "status": "OK",
    "data": [
        {
            "sys_id":
156016554400838540
"165166624317136512",
            "
parent
application_id":
null,
{
                "
sys_updated_at
value": "
2019-06-10 11:19:04
155931135900000002",
"impact": null, 
    
"
number
link": "
TSK002930",
http://your-instance.example.ru/rest/v1/table/sys_application/155931135900000002"
"sys_created_at": "2019-06-10 11:19:04"
},
            "
assigned_user
description":
{ 
"Some description",
            
"
value
name": "
155964310500000018
My Dashboard",

            "
link
policy": "
https://your-instance-address.com/rest/v1/table/user/155964310500000018"
Open",
}
"refresh_time": "300",
            "sys_created_at": "2022-05-04 12:10:43",
            "sys_
updated
created_by": {
                "value": "
155964310500000018
155931135900000001",
                "link": "
https
http://your-instance
-address
.example.
com
ru/rest/v1/table/user/
155964310500000018
155931135900000001"
            },
            "
active
sys_updated_at":
null
"2022-05-04 12:10:43",
            "
opened
sys_updated_
at
by":
null,
{
                "
contact
value":
{ "value": "
"155931135900000001",
                "link": "
https
http://your-instance
-address
.example.
com
ru/rest/v1/table/user/155931135900000001"
            }
,
"sys_created_by": {
}
"value": "155964310500000018", "link": "https://your-instance-address.com
]
}




READ operations


GET /rest/v1/table/{tableName}

This method returns multiple records for thespecified table.


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

This method retrieves one record from the specified table.

Parameters

NameDescription
sysparm_query

An encoded query string used to filter the results.

Value example: last_nameENDSWITHov.

sysparm_display_value

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

  • true – returns field display values.
  • false – returns actual values.

Default value: false.

sysparm_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 value: false.

sysparm_fields

A comma-separated list of fields to return to the response.

Value example: username,email.

sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

Value example: SP.

sysparm_limit

The maximum number of results returned per page.

Default value: 20 (for GET-queries).

sysparm_page

Page number to offset records.

Default value: 1.


Note

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


Section


Code Block
languagejs
themeEclipse
titleCode Snippet
linenumberstrue
GET /rest/v1/table/itsm_change_request HTTP/1.1
Host: your-instance.example.ru
Authorization: Basic am91bi5kb4U6MTIzNDU2Nzg6
Cookie: SERVERID=srv-ocXctExSS6esqqmrg3ZkKA|Wqnmc


Code Block
languagejs
themeConfluence
titleResponse
linenumberstrue
collapsetrue
{
    "status": "OK",
    "data": [
        {
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
sys_
notes
id":
null
"156951264211094636",
            "
additional
application_
comments
id":
null, 
{
                "
closed_by
value":
null
"155931135900000002",
"opened_by":
null, 
   
"link": "http://your-instance.example.ru/rest/v1/table/sys_application/155931135900000002"
"due_date": null
  },
            "
sys_db_table_id
description":
155964310500000025
"",
            "
urgency
elevated_privilege":
null
false,
            "
policy
name": "
Open
impersonator",
            "
total_points
policy":
0
"Protected",
            "
burned
sys_created_
points
at":
null
"2019-09-30 00:00:00",
            "
caller
sys_created_by":
null,
{
                "
state
value":
7
"155931135900000001",
"description":
null, 
            "
subject
link": "
1
http://your-instance.example.ru/rest/v1/table/user/155931135900000001"
},
{
},
            "sys_updated_
id
at":
155964310500002012
 "2019-12-17 15:32:15",
            "
parent
sys_updated_
id
by":
null,
{
"sys_updated_at"
   "value": "
2019-06-18 15:28:32
155931135900000001",
"impact":
null, 
            "
number
link": "
TSK002836",
http://your-instance.example.ru/rest/v1/table/user/155931135900000001"
"sys_created_at": "2019-02-19 14:30:19",
}
        }
"assigned_user": null, "sys_updated_by": { "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
languagexml
themeConfluence
titlesysparm_page
collapsetrue
{
    "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
languagexml
titlesysparm_fields
collapsetrue
{
    "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
languagexml
themeConfluence
titlesysparm_fields
collapsetrue
{
    "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
languagexml
themeConfluence
titlesysparm_display_value
collapsetrue
{
    "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
languagexml
titlesysparm_exclude_reference_link
collapsetrue
{
    "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
languagexml
themeConfluence
titleCREATE
collapsetrue
{
    "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
languagexml
themeConfluence
titleUPDATE
collapsetrue
{
    "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 UPDATE operations:

  • PUT creates records or updates records with values defined in the request body.
  • PATCH is used to partially update records.

In other words, in PATCH, nested objects contain a set of instructions that describe how records on the origin server should be updated to create new versions. And PUT contains new versions of records.

PUT /rest/v1/table/{tableName}/{sys_id}

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

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

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

Parameters

NameDescription
sysparm_display_value

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

  • true – returns field display values.
  • false – returns actual values.

Default value: false.

sysparm_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 value: false.

sysparm_fields

A comma-separated list of fields to return to the response.

Value example: username,email.

sysparm_view

Render the response according to the specified UI view (overridden by sysparm_fields).

Value example: SP.

Body parameter

ParameterValue
column_namecolumn_value


Note

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


Section


Code Block
languagejs
themeEclipse
titleCode Snippet
linenumberstrue
PUT /rest/v1/table/user/164926188012940692 HTTP/1.1 
Host: your-instance.example.ru 
Content-Type: application/json
Authorization: Basic am91bi5kb4U6MTIzNDU2Nzg6
Cookie: SERVERID=srv-ocXctExSS6esqqmrg3ZkKA|Wqnmc
Content-Length: 26

{
	"username": "john.doe"
}


Code Block
languagexml
themeConfluence
titlePUT Response
linenumberstrue
collapsetrue
{
    "status": "OK",
    "data": [
        {
            "sys_id": "164926188012940692",
            "active": true,
Code Block
languagexml
themeConfluence
titleUPDATE
collapsetrue
{ "status": "OK", "data": [ {

            "
sys
auth_
id
key":
155983188102317352
null,
            "
parent_id
company": null,
            "
sys
date_
updated
format_
at
id": {
                "
expression
value": "
NOW()
159836398504170273",
                "
params
link":
[] 
"http://your-instance.example.ru/rest/v1/table/sys_date_format/159836398504170273"
},
"impact": null
  },
            "
number
department":
"TSK002926"
null,
            "
sys
display_
created_at
name": "
2019-06-06 14:38:01
John Doe",
            "
assigned_user
email":
null
"johndoe@mail.com",
            "
sys
first_
updated_by
name":
{ 
"John",
            
"
value
language_id":
"155964310500000001",
{
                "
link
value": "
https://your-instance-address.com/rest/v1/table/user/155964310500000001" 
156628684306200767",
}, 
            "
active
link":
null,
"http://your-instance.example.ru/rest/v1/table/sys_language/156628684306200767"
"opened_at": null
},
            "
contact
last_name":
{ 
"Doe",
            
"
value
ldap_server_id":
""
null,

            "
link
location":
"https://your-instance-address.com/rest/v1/table/user/" 
null,
}
"locked_out": false,
            "
sys_created_by
log_out_on_all_devices":
{
false,

            
"
value
photo_id":
"155964310500000018"
null,

            
"
link
primary_group":
"https://your-instance-address.com/rest/rest/v1/table/user/155964310500000018"
null,
}
"source": "",
            "
closed
sys_created_at":
null
"2022-04-06 16:18:00",
            "
display
sys_created_
name
by":
"TSK002926 1", 
 {
                "
steps_to_reproduce
value":
null
"155931135900000001",
                "
priority
link":
null,
"http://your-instance.example.ru/rest/v1/table/user/155931135900000001"
"screenshot": null
},
            "
attention_required
sys_db_table_id":
false
"155931135900000084",
            "
assignment
sys_updated_
group
at":
null
"2022-04-29 11:25:53",
            "
watcher
sys_updated_
list
by": {
                "value": "155931135900000001",
                "link": "
https
http://your-instance
-address.com/rest
.example.ru/rest/v1/table/user/
" }, "company": null, "work_notes": null, "additional_comments": null,
155931135900000001"
"closed_by": null
},
            "
opened
timezone_
by
id":
null, 
{
                "
due_date
value":
null
"156076775207685877",
"sys_db_table_id":
155964310500000025,
"urgency": null,
"link": "http://your-instance.example.ru/rest/v1/table/sys_timezone/156076775207685877"
"policy": "Changed"
},
            "
total_points
username":
0,
"john.doe"
        }
"burned_points": null, "caller": 155964310500000002, "state": 7, "description": null, "subject": "1" } ] }
DELETE operations
]
}


DELETE operations

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

Deletes the specified record with the request body from the specified table.

You can receive one of two possible responses:

  • When the record was successfully deleted.
  • When an error occurred.
Note

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


Code Block
languagejs
themeEclipse
titleCode Snippet
linenumberstrue
DELETE /rest/v1/table/dashboard/165476748114102626 HTTP/1.1 
Host: your-instance.example.ru
Content-Type: application/json
Authorization: Basic am91bi5kb4U6MTIzNDU2Nzg6
Cookie: SERVERID=srv-ocXctExSS6esqqmrg3ZkKA|Wqnmc
Content-Length: 23

{
	"method": "DELETE"
}

Success response

Code Block
languagejs
themeEclipseConfluence
titlelinenumbersDelete successtrue
{
    "status": "OK",
    "data": {
        "description": "Records successfully deleted."
    }
}

Error response

Code Block
languagejs
themeConfluence
titlelinenumbersDelete failtrue
{
    "status": "ERROR",
    "error_type": "SERVER",
    "errors": [
        {
            "message": "You have no access to delete this records."
        }
    ]
}

Authorization

Image Removed

 Table of Contents
absoluteUrltrue
classfixedPosition