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	https://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

POST

{
...
<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 one record from the essence table.

UPDATE operations

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.

Parameters

Parameter	Value
column_name	column_value

PATCH

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

DELETE operations

DELETE /v1/table/{essence}/{sys_id}
Deletes the value from the sys_id 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. 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.

Code Examples

sysparm_limit

{
    "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": "http://rest.simple.test:8080/v1/table/user/155964310500000018"
            },
            "sys_updated_by": {
                "value": "155964310500000018",
                "link": "http://rest.simple.test:8080/v1/table/user/155964310500000018"
            },
            "active": null,
            "opened_at": null,
            "contact": {
                "value": "",
                "link": "http://rest.simple.test:8080/v1/table/user/"
            },
            "sys_created_by": {
                "value": "155964310500000018",
                "link": "http://rest.simple.test:8080/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": "http://rest.simple.test:8080/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"
        },
        {
            "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": "155964310500000018",
                "link": "http://rest.simple.test:8080/v1/table/user/155964310500000018"
            },
            "active": true,
            "opened_at": null,
            "contact": {
                "value": "",
                "link": "http://rest.simple.test:8080/v1/table/user/"
            },
            "sys_created_by": {
                "value": "155964310500000026",
                "link": "http://rest.simple.test:8080/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": ""
        }
    ]
}

Page tree