Page History

Table API позволяет вам производить операции CRUD (создание, чтение, обновление и удаление) на созданных таблицах.

Запросы CRUD на таблицу Table API выполняются согласно правилам контроля доступам (ACL).

Формат URL Table API:

Название	Значение
URL по умолчанию	/rest/v1/table/

Авторизация

Два типа запросов на авторизацию поддерживаются для Table API:

Basic Auth – аутентификация включает в себя отправку запроса с проверенным именем пользователя и паролем.
Bearer Token –аутентификация с ключом доступа. Токен представляет собой текстовую строку, которая включена в заголовок запроса.

Операция CREATE

Используйте метод POST, чтобы создать запись в указанной таблице. Метод не поддерживает создание нескольких записей.

Пример:

Code Block
POST /rest/v1/table/{tableName}

Параметры тела запроса

Вы можете указывать необходимое количество колонок и их значений.

Параметр	Значение
column_name	column_value

Используйте следующие параметры с этим методом:

Параметр	Описание
sysparm_display_value	Метод операции для извлечения данных. Может возвращать два типа значений: 1 – возвращает отображаемое значение поля. 0 – возвращает значение поле из базы данных. Значение по умолчанию: 0.
sysparm_exclude_reference_link	Флажок, указывающий на исключение ссылок Table API (/rest/v1/table/) для ссылочных полей. Валидные значения: 1 – исключить ссылки Table API для ссылочных полей. 0 – включить ссылки Table API для ссылочных полей. Значение по умолчанию: 0.
sysparm_fields	Список полей, разделенных запятой, которые должны вернуться в ответе. Пример значения: number,caller.
sysparm_view	Ответ содержит поля представления формы, указанной в этом параметре. Обратите внимание, что параметр может быть переопределено параметром sysparm_fields Значение по умолчанию: Default.

Note
Используйте тело запроса типа raw JSON вместо form-data.

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

{
  "status": "OK",
  "data": [
    {
      "sys_id": "166031411802010329",
      "state": "7",
      "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,
      "opened_by": null,
      "caller": {
        "value": "155931135900000001",
        "link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
      },
      "contact": null,
      "service": null,
      "screenshot": null,
      "short_description": null,
      "work_notes": null,
      "active": true,
      "closed_at": null,
      "sla_due": null,
      "sys_updated_at": "2022-08-12 14:21:58",
      "sys_created_at": "2022-08-12 14:21:58",
      "description": null,
      "number": "TSK0000006",
      "subject": "Task created by REST",
      "additional_comments": null,
      "comments": null,
      "opened_at": "2022-08-12 14:21:58",
      "due_date": null,
      "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

Операции чтения в SimpleOne ограничены методом GET.

Для извлечения одной записи из указанной таблицы, используйте следующий шаблон URL:
Code Block
GET /rest/v1/table/{tableName}/{sys_id}
Для извлечения нескольких записей, используйте следующий шаблон URL:
Code Block
GET /rest/v1/table/{tableName}

Используйте следующие параметры с этим методом:

Параметр	Описание
sysparm_query	An encoded query string used to filter the results. Пример значения: active=1.
sysparm_display_value	Метод операции для извлечения данных. Может возвращать два типа значений: 1 – возвращает отображаемое значение поля. 0 – возвращает значение поле из базы данных. Значение по умолчанию: 0.
sysparm_exclude_reference_link	Флажок, указывающий на исключение ссылок Table API (/rest/v1/table/) для ссылочных полей. Валидные значения: 1 – исключить ссылки Table API для ссылочных полей. 0 – включить ссылки Table API для ссылочных полей. Значение по умолчанию: 0.
sysparm_fields	Список полей, разделенных запятой, которые должны вернуться в ответе. Пример значения: number,caller.
sysparm_view	Ответ содержит поля представления формы, указанной в этом параметре. Обратите внимание, что параметр может быть переопределено параметром sysparm_fields Значение по умолчанию: Default.
sysparm_limit	Максимальное количество результатов, возвращаемое запросом. Значение по умолчанию: 20.
sysparm_page	Укажите номер страницы, с которой начнется чтение. Например если значнение параметра sysparm_limit – 40, а у sysparm_page значение равно двум, то ответ будет включать записи 21-60. Значение по умолчанию: 1.

Note
Используйте тело запроса типа raw JSON вместо form-data.

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

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

Операция UPDATE

Для операции обновления доступны два метода: PUT и PATCH. PUT содержит новые версии записи, в то время как в PATCH вложенные объекты содержат набор инструкций, которые описывают как записи исходного сервера должны обновляться, чтобы создавать новые версии.

Параметры тела

Вы можете указывать необходимое количество колонок и их значений.

Параметр	Значение
column_name	column_value

Используйте следующие параметры с этим методом:

Parameter	Description
sysparm_display_value	Метод операции для извлечения данных. Может возвращать два типа значений: 1 – возвращает отображаемое значение поля. 0 – возвращает значение поле из базы данных. Значение по умолчанию: 0.
sysparm_exclude_reference_link	Флажок, указывающий на исключение ссылок Table API (/rest/v1/table/) для ссылочных полей. Валидные значения: 1 – исключить ссылки Table API для ссылочных полей. 0 – включить ссылки Table API для ссылочных полей. Значение по умолчанию: 0.
sysparm_fields	Список полей, разделенных запятой, которые должны вернуться в ответе. Пример значения: number,caller.
sysparm_view	Ответ содержит поля представления формы, указанной в этом параметре. Обратите внимание, что параметр может быть переопределено параметром sysparm_fields Значение по умолчанию: Default.

Note
Используйте тело запроса типа raw JSON вместо form-data.

PUT

Используйте метод для обновления записей в указанной таблице, используя значения, которые определены в теле запроса.

Пример:

Code Block

theme	Eclipse

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

PATCH

Используйте метод для частичного обновления записей. Этот метод обновляет определенную запись в указанной таблице с телом запроса.

Пример:

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

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,
        "opened_by": null,
        "caller":
        {
            "value": "155931135900000001",
            "link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
        },
        "contact": null,
        "service": null,
        "screenshot": null,
        "short_description": null,
        "work_notes": null,
        "active": true,
        "closed_at": null,
        "sla_due": null,
        "sys_updated_at": "2022-08-13 13:46:11",
        "sys_created_at": "2022-08-12 17:32:06",
        "description": null,
        "number": "TSK0000014",
        "subject": "Kickoff meeting",
        "additional_comments": null,
        "comments": null,
        "opened_at": "2022-08-12 17:32:06",
        "due_date": null,
        "attention_required": false,
        "company":
        {
            "value": "166032365806600708",
            "link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/org_company/166032365806600708"
        },
        "approval_state": "not_requested",
        "sys_db_table_id": "155931135900000083",
        "display_name": "TSK0000014 Kickoff meeting",
        "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"
        }
    }]
}

Операция DELETE

Используйте метод, чтобы удалять определенную запись из таблицы с телом запроса.

Пример:

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

Возможно два типа ответа:

Запись была успешно удалена.
Возникла ошибка.

Пример:

Code Block

language	js
theme	Eclipse
title	HTTP
linenumbers	true

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

Ответ об успешном удалении

Code Block

language	js
theme	Confluence
linenumbers	true

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

Ответ о возникновении ошибки

Code Block

language	js
theme	Confluence
linenumbers	true

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

Table of Contents

absoluteUrl	true
class	fixedPosition
printable	false

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Авторизация

Операция CREATE

Операция READ

Операция UPDATE

PUT

PATCH

Операция DELETE