Page History

The REST API allows you to perform the create, read, update, and delete (CRUD) operations on existing tables. Requests to perform the CRUD operations through the REST API are executed according to <![CDATA[ACL rules.

URL format:

Name	Value
Default URL	/rest/v1

Authorization

In SimpeOneSimple, 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 RemovedImage Added

CREATE operations

POST /rest/v1/table/{tableName}
This method allows for inserting one record in the defined table. It does not support multiple records insertion.

Parameters

Body parameter

NameParameter

DescriptionValue

sysparmcolumn_name

columndisplay_value

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

true – returns field display values.
false – returns database field values.

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

ParameterValuecolumn_namecolumn_value

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

Image Added

Section

Code Block

language	js
theme	Eclipse
title	HTTP
linenumbers	true

<![CDATA[POST /rest/v1/table/task

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

Section

Code Block

language	js
theme	Eclipse
title	Code Snippet
linenumbers	true

POST /rest/v1/table/dashboard HTTP/1.1
Host: yoursandbox-instance01.dev.examplesimpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
Content-Type: application/json
Authorization: Basic am91bi5kb4U6MTIzNDU2Nzg6
Cookie: SERVERID=srv-ocXctExSS6esqqmrg3ZkKA|Wqnmc
ContentContent-Length: 14143

 {  
            "namesubject": "MyTask Dashboard",created              
            "description":"Some description",
            "refresh_time": "300"  
 }by REST"
}

Code Blockcode

language	js
theme	Confluence
title	Response
linenumbers	true
collapse	true

<![CDATA[{
    "status": "OK",
    "data": [
        {
  {
          "sys_id": "165166624317136512166031411802010329",
      "state": "7",
      "application_idpriority": {null,
      "urgency": null,
         "valueimpact": "155931135900000002"null,
        "assigned_user": null,
        "linkassignment_group": "http://your-instance.example.ru/rest/v1/table/sys_application/155931135900000002"
null,
      "wf_executing_activity": null,
      } "closed_by": null,
      "followers_list": null,
      "descriptionparent_id": "Some description"null,
            "nameopened_by": "My Dashboard"null,
            "policycaller": "Open",
  {
          "refresh_timevalue": "300155931135900000001",
            "sys_created_atlink": "2022-05-04 12:10:43",http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
      },
      "sys_created_bycontact": {null,
        "service": null,
        "valuescreenshot": "155931135900000001"null,
         "short_description": null,
       "linkwork_notes": "http://your-instance.example.ru/rest/v1/table/user/155931135900000001"null,
      "active": true,
       }"closed_at": null,
        "sla_due": null,
      "sys_updated_at": "2022-0508-0412 1214:1021:4358",
            "sys_updatedcreated_byat": { "2022-08-12 14:21:58",
      "description": null,
         "valuenumber": "155931135900000001TSK0000006",
      "subject": "Task created by REST",
      "linkadditional_comments": "http://your-instance.example.ru/rest/v1/table/user/155931135900000001"null,
            }"comments": null,
        }
"opened_at": "2022-08-12 14:21:58",
      "due_date": null,
      ]
}

READ operations

GET /rest/v1/table/{tableName}

This method returns multiple record query from the specified table.

"attention_required": false,
      "company": null,
      "approval_state": "not_requested",
      "sys_db_table_id": "155931135900000083",
      "display_name": "TSK0000006 Task created by REST",
      "sys_updated_by": {
        "value": "155931135900000001",
        "link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
      },
      "sys_created_by": {
        "value": "155931135900000001",
        "link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
      }
    }
  ]
}

READ operations

GET /rest/v1/table/{tableName}
This method returns multiple record query from the specified table.

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

Parameters

Name	Description
sysparm_query	An encoded query string used to filter the results. Value example: active=1.
sysparm_display_value	Data retrieval operation method. Also, may return both types of values. true – returns field display values. false – returns database field values. Default value: 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 value: false.
sysparm_fields	A comma-separated list of fields to return to the response. Value example: number,caller.
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 by query. Default value: 20 (for GET-queries).
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
You need to use raw JSON type of Body instead of form-data.

Image Added

Section

Code Block

language	js
theme	Eclipse
title	HTTP
linenumbers	true

<![CDATA[GET /rest/v1/table/task?sysparm_query=active=1&sysparm_fields=number,caller&sysparm_limit=1&sysparm_exclude_reference_link=true 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

<![CDATA[{
    "status": "OK",
    "data": [
        {
            "number": "TSK0000006",
            "caller": 155931135900000001
        }
    ]
}

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

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

Parameters

NameDescriptionsysparm_query

An encoded query string used to filter the results.

Value example: active=1.

sysparm_display_value

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

true – returns field display values.
false – returns database field 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: number,caller.

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 by query.

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

language	js
theme	Eclipse
title	Code Snippet
linenumbers	true

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

language	js
theme	Confluence
title	Response
linenumbers	true
collapse	true

{
    "status": "OK",
    "data": [
        {
            "sys_id": "156951264211094636",
            "application_id": {
                "value": "155931135900000002",
                "link": "http://your-instance.example.ru/rest/v1/table/sys_application/155931135900000002"
            },
            "description": "",
            "elevated_privilege": false,
            "name": "impersonator",
            "policy": "Protected",
            "sys_created_at": "2019-09-30 00:00:00",
            "sys_created_by": {
                "value": "155931135900000001",
                "link": "http://your-instance.example.ru/rest/v1/table/user/155931135900000001"
            },
            "sys_updated_at": "2019-12-17 15:32:15",
            "sys_updated_by": {
                "value": "155931135900000001",
                "link": "http://your-instance.example.ru/rest/v1/table/user/155931135900000001"
            }
        }
    ]
}

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

NameDescriptionsysparm_display_value

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

true – returns field display values.
false – returns database field values.

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

Parameter	Value
column_name	column_value

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

Image Added

Section

Code Block

language	js
theme	Eclipse
title	Code SnippetHTTP
linenumbers	true

<![CDATA[PUT /rest/v1/table/usertask/164926188012940692166032552604350116 HTTP/1.1 
Host: yoursandbox-instance01.dev.examplesimpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
Content-Type: application/json
Authorization: Basic am91bi5kb4U6MTIzNDU2Nzg6
Cookie: SERVERID=srv-ocXctExSS6esqqmrg3ZkKA|Wqnmc
Content-Length: 2620

{
	  "usernamestate": "john.doe3"
}

Code Block

language	xmljs
theme	Confluence
title	PUT Response
linenumbers	true
collapse	true

<![CDATA[{
    "status": "OK",
    "data": [
        {
            "sys_id": "164926188012940692166032552604350116",
            "activestate": true"3",
            "auth_keypriority": null,
            "companyurgency": null,
            "date_format_idimpact": {null,
        "assigned_user": null,
        "valueassignment_group": "159836398504170273"null,
        "wf_executing_activity": null,
       "link": "http://your-instance.example.ru/rest/v1/table/sys_date_format/159836398504170273"
    "closed_by": null,
        "followers_list": null,
         }"parent_id": null,
        "opened_by": null,
        "departmentcaller": null,
        {
            "display_namevalue": "John Doe155931135900000001",
            "emaillink": "johndoe@mail.com",
http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
        },
        "first_namecontact": "John"null,
            "language_idservice": {null,
        "screenshot": null,
        "valueshort_description": "156628684306200767"null,
        "work_notes": null,
        "linkactive": "http://your-instance.example.ru/rest/v1/table/sys_language/156628684306200767"true,
            },
    "closed_at": null,
        "lastsla_namedue": "Doe"null,
            "ldapsys_serverupdated_idat": null "2022-08-13 13:46:11",
        "sys_created_at":    "location": null,
    "2022-08-12 17:32:06",
        "locked_outdescription": falsenull,
            "log_out_on_all_devicesnumber": false"TSK0000014",
            "photo_idsubject": "Kickoff nullmetting",
            "primaryadditional_groupcomments": null,
     null,
        "sourcecomments": ""null,
            "sys_created"opened_at": "2022-0408-0612 1617:1832:0006",
        "due_date": null,
        "sys_created_by": {
attention_required": false,
        "company":
        {
            "value": "155931135900000001166032365806600708",
                "link": "http://yoursandbox-instance01.dev.examplesimpleone.ru/rest/v1/table/userorg_company/155931135900000001166032365806600708"
        },
    },
    "approval_state": "not_requested",
        "sys_db_table_id": "155931135900000084155931135900000083",
            "sys_updated_at"display_name": "2022-04-29 11:25:53TSK0000014 Kickoff metting",
            "sys_updated_by":
  {
      {
            "value": "155931135900000001",
                "link": "http://yoursandbox-instance01.dev.examplesimpleone.ru/rest/v1/table/user/155931135900000001"
            },
            "timezonesys_created_idby":
  {
      {
            "value": "156076775207685877155931135900000001",
                "link": "http://yoursandbox-instance01.dev.examplesimpleone.ru/rest/v1/table/sys_timezone/156076775207685877"
            },
            "username": "john.doeuser/155931135900000001"
        }
    }]
}

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.

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

Image Added

Code Block

language	js
theme	Eclipse
title	Code SnippetHTTP
linenumbers	true

<![CDATA[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"
}sys_filter/166039918402151705 HTTP/1.1
Host: sandbox-01.dev.simpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu

Success response

Code Block

language	js
theme	Confluence
linenumbers	true

<![CDATA[{
    "status": "OK",
    "data": {
        "description": "Records successfully deleted."
}

Error response

Code Block

language	js
theme	Confluence
linenumbers	true

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

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 45

New Version 46

Key

Authorization

CREATE operations

READ operations

READ operations

UPDATE operations

UPDATE operations

DELETE operations