Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

Формат URL Table API:

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


Авторизация

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

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

Image Added

Операция 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.

Параметр поддерживает использование dot-walking.

Note

Dot-walking не работает для таблицы Запланированные задания (sys_schedule_job), ее дочерних таблиц и таблицы Индикаторы (sys_indicator), так как после создания запись проходит обработку и не сразу появляется в базе данных.

Пример значения: number,caller.phone

sysparm_view

Представление формы, поля которого должны вернуться в ответе. Обратите внимание, что этот параметр может быть переопределен параметром sysparm_fields.

Из набора колонок представления, указанного в sysparm_view, выводятся только те, что указаны в sysparm_fields. Если указаны поля в sysparm_fields, которых нет в выбранном представлении, оно не выведется.

Info

Если параметр не задан, в ответе на запрос возвращаются значения всех колонок таблицы.



Note

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

Image Added

Section


Code Block
languagejs
themeEclipse
titleHTTP
linenumberstrue
POST /rest/v1/table/task 
Section
Code Block
languagejs
themeEclipse
titleHTTP
linenumberstrue
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
languagejs
themeConfluence
titleResponse
linenumberstrue
collapsetrue
{
  "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

Декодированная Закодированная строка запроса, которая используется для фильтрации результатов. Параметр поддерживает использование dot-walking.

Пример значения: 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

Список полей, разделенных запятой, которые должны вернуться в ответе. Параметр поддерживает использование dot-walking.

Пример значения: number,caller.phone

sysparm_viewОтвет содержит поля представления

Представление формы,

указанной в этом параметре

поля которого должны вернуться в ответе. Обратите внимание, что этот параметр может быть

переопределено параметром

переопределен параметром sysparm_fields

Значение по умолчанию: Default

.

Из набора колонок представления, указанного в sysparm_view, выводятся только те, что указаны в sysparm_fields. Если указаны поля в sysparm_fields, которых нет в выбранном представлении, оно не выведется.

Info

Если параметр не задан, в ответе на запрос возвращаются значения всех колонок таблицы.


sysparm_limit

Максимальное количество результатов, возвращаемое запросом.

sysparm_limit

Максимальное количество результатов, возвращаемое запросом.

Значение по умолчанию: 20.

sysparm_page

Укажите номер Номер страницы, с которой начнется чтение. Например, если значнение значение параметра sysparm_limit – 40, а у sysparm_page значение равно двум, то ответ будет включать записи 21-6021–60.

Значение по умолчанию: 1.


Note

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

Image Added

Section


Code Block
languagejs
themeEclipse
titleHTTP
linenumberstrue
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
languagejs
themeConfluence
titleResponse
linenumberstrue
collapsetrue
{
    "status": "OK",
    "data": [
        {
            "number": "TSK0000006",
            "caller": 155931135900000001
        }
    ]
}




Операция UPDATE


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

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

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

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

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

ParameterDescription
sysparm_display_value

Метод операции для извлечения данных. Может возвращать два типа значений:Флаг, определяющий тип возвращаемых данных. Валидные значения:

  • 1 – возвращает отображаемое значение поля.
  • 0 – возвращает значение поле из поля из базы данных.

Значение по умолчанию: 0.

sysparm_exclude_reference_link

ФлажокФлаг, указывающий на исключение ссылок Table API (/rest/v1/table/) для ссылочных полей.

Валидные значения:

  • 1 – исключить ссылки Table API для ссылочных полей.
  • 0 – включить ссылки Table API для ссылочных полей.

Значение по умолчанию: 0.

sysparm_fields

Список полей, разделенных запятой, которые должны вернуться в ответе. Параметр поддерживает использование dot-walking.

Пример значения: number,caller.phone

sysparm_viewОтвет содержит поля представления

Представление формы,

указанной в этом параметре

поля которого должны вернуться в ответе. Обратите внимание, что этот параметр может быть

переопределено параметром

переопределен параметром sysparm_fields

Значение по умолчанию: Default.

Note

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

PUT

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

Пример:

.

Из набора колонок представления, указанного в sysparm_view, выводятся только те, что указаны в sysparm_fields. Если указаны поля в sysparm_fields, которых нет в выбранном представлении, оно не выведется.

Info

Если параметр не задан, в ответе на запрос возвращаются значения всех колонок таблицы.



Note

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

Image Added

PUT


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

Пример:

Code Block
themeEclipse
Code Block
themeEclipse
PUT /rest/v1/table/{tableName}/{sys_id}

PATCH

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

Пример:

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


Section


Code Block
languagejs
themeEclipse
titleHTTP
linenumberstrue
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
languagejs
themeConfluence
titleResponse
linenumberstrue
collapsetrue
{
    "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"
        }
    }]
}


PATCH


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

Пример:

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


section
Section


Code Block
languagejs
themeEclipse
titleHTTP
linenumberstrue
PATCH /rest/v1/table/task/166032552604350116 HTTP/1.1
Host: sandbox-01.dev.simpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
Content-Type: application/json
Content-Length: 43

{
  "description": "Some description"
}


Code Block
languagejs
themeEclipse
titleHTTP
linenumberstrue
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"
}
Confluence
titleResponse
linenumberstrue
collapsetrue
{
    "status": "OK",
    "data": [
        {
            "active": true,
            "additional_comments": null,
            "approval_state": "not_requested",
            "assigned_user": null,
            "assignment_group": null,
            "attention_required": false,
            "caller":
Code Block
languagejs
themeConfluence
titleResponse
linenumberstrue
collapsetrue
{
    "status": "OK",
    "data": [
    {
        "sys_id": "166032552604350116",
        "statevalue": "3155931135900000001",
        "priority": null,
        "urgencylink": null,"http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"
        "impact": null    },
            "assignedclosed_userat": null,
            "assignmentclosed_groupby": null,
            "wf_executing_activitycomments": null,
        "closed_by    "company": null,
            "followers_listcontact": null,
        "parent_id    "description": "Some nulldescription",
            "opened_by": nulldisplay_name": "TSK0000005 Some subject",
        "caller":
        {"due_date": null,
            "valuefollowers_list": "155931135900000001"null,
            "linkimpact": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"2",
        },
        "contactnumber": null"TSK0000005",
         "service   "opened_at": null"2023-08-10 11:55:30",
        "screenshot    "opened_by": null,
            "shortparent_descriptionid": null,
        "work_notes    "priority": null"2",
            "activescreenshot": truenull,
         "closed_at   "service": null,{
        "sla_due": null,
        "sys_updated_atvalue": "2022-08-13 13:46:11157416651911910348",
              "sys_created_at  "link": "2022-08-12 17:32:06",
  http://sandbox-01.dev.simpleone.ru/rest/v1/table/sys_cmdb_ci_service/157416651911910348"
      "description": null,
     },
   "number": "TSK0000014",
        "subjectshort_description": "Kickoff meeting"null,
            "additionalsla_commentsdue": null,
            "commentsstate": null,
 "1",
            "openedstate_changed_at": "20222023-08-1210 1711:3255:0630",
         "due_date   "subject": null"Some subject",
            "attentionsys_created_requiredat": false"2023-08-10 11:55:30",
        "company    "sys_created_by":
   {
     {
            "value": "166032365806600708155931135900000001",
                "link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/org_companyuser/166032365806600708155931135900000001"
            },
        "approval_state    "sys_db_table_id": "not_requested155931135900000083",
            "sys_db_table_id": "155931135900000083169166853014539923",
            "display_name": "TSK0000014 Kickoff meeting",
sys_updated_at": "2023-08-10 11:56:25",
            "sys_updated_by": {
        {
            "value": "155931135900000001169166788816565275",
                "link": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001169166788816565275"
            },
        "sys_created_by":
        {"urgency": "2",
            "valuewf_executing_activity": "155931135900000001"null,
            "linkwork_notes": "http://sandbox-01.dev.simpleone.ru/rest/v1/table/user/155931135900000001"null
        }
    }]
}


Операция DELETE


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

Пример:

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

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

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

Image Added

Пример:

Code Block
languagejs
themeEclipse
titleHTTP
linenumberstrue
DELETE /rest/v1/table/sys_filter/166039918402151705 HTTP/1.1
Host: sandbox-01.dev.simpleone.ru
Authorization: Bearer 70xlHwLAgSeBKF7Dafbu-lcUrWlvw4eu
Ответ об успешном удалении


Code Block
languagejs
themeConfluence
titleОтвет об успешном удалении
linenumberstrue
{
    "status": "OK",
    "data": {
        "description": "Records successfully deleted."
}

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


Code Block
languagejs
themeConfluence
titleОтвет о возникновении ошибки
linenumberstrue
{
    "status": "ERROR",
    "error_type": "SERVER",
    "errors": [
        {
            "message": "You have no access to delete this records."
        }
    ]
}


Table of Contents
absoluteUrltrue
classfixedPosition
printablefalse