Методы группы Segment внешнего программного интерфейса менеджера сервиса предназначены для выполнения различных действий с сегментами сервиса Фреш.

Сводка по методам

МетодНазначение
segment/createСоздает сегмент сервиса
segment/deleteУдаляет сегмент сервиса
segment/listПолучает список сегментов сервиса
segment/updateИзменяет сегмент сервиса

segment/create

Создает сегмент сервиса

ПараметрТипОписаниеПример
Запрос
nameСтрока переменная (25)Наименование сегмента1cfresh.com 13
use_subdomain *БулевоПризнак использования поддоменаtrue
domain_name *Строка переменная (255)Выделенное доменное имяcustom.1cfresh.com
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/segment/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "name": "1cfresh.com 13",
  "use_subdomain": true,
  "domain_name": "custom.1cfresh.com"
}
Пример ответа  Развернуть
{
  "id": "000000007",
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

segment/delete

Удаляет сегмент сервиса

ПараметрТипОписаниеПример
Запрос
idСтрока переменная (9)Код элемента000000007
deletion_markБулевоПометка удаленияfalse
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/segment/delete
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000007",
  "deletion_mark": false
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

segment/list

Получает список сегментов сервиса

ПараметрТипОписаниеПример
Запрос
filter *
Отбор элементов
  - keyСтрока (перечисление)Поле отбора:
  • name
name
  - valueСтрока переменная (150)Значение отбора1cfresh
Ответ: list (0..*)
idСтрока переменная (9)Код элемента000000007
deletion_markБулевоПометка удаленияfalse
nameСтрока переменная (25)Наименование сегмента1cfresh.com 13
use_subdomain *БулевоПризнак использования поддоменаtrue
domain_name *Строка переменная (255)Выделенное доменное имяcustom.1cfresh.com
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/segment/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

Пример ответа  Развернуть
{
  "list": [
    {
      "id": "000000007",
      "deletion_mark": false,
      "name": "1cfresh.com 13",
      "use_subdomain": true,
      "domain_name": "custom.1cfresh.com"
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

segment/update

Изменяет сегмент сервиса

ПараметрТипОписаниеПример
Запрос
idСтрока переменная (9)Код элемента000000007
name *Строка переменная (25)Наименование сегмента1cfresh.com 13
use_subdomain *БулевоПризнак использования поддоменаtrue
domain_name *Строка переменная (255)Выделенное доменное имяcustom.1cfresh.com
Ответ: list (0..*)
Нет параметров
Пример запроса  Развернуть
POST https://1cfresh.com/a/adm/hs/ext_api/execute/srv/segment/update
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": "000000007",
  "name": "1cfresh.com 13",
  "use_subdomain": true,
  "domain_name": "custom.1cfresh.com"
}
Пример ответа  Развернуть
{
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 37,
    "sm_version": "1.1.48.6",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх