Метод создает элемент памяти с параметрами.

Адрес/v1.0/memoryitems/params
ТипPOST 
LoginТребуется 

Входные параметры

Входные параметры передаются в теле запроса в raw JSON:

ПараметрОбязательностьОписаниеВозможные значения

aliasId

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

name

ОбязателенНазвание элемента памяти

description

ОпционаленОписание элемента памяти

accessType

ОбязателенТип доступа к памяти
  • 0 — read and write;
  • 1 — read only;
  • 2 — write only

readPassword

ОпционаленПароль на чтение

writePassword

ОпционаленПароль на запись

maxaccesserrors

Опционален

Максимальное количество неправильных попыток доступа к элементу памяти по паролю до ее блокировки.

По умолчанию — 5 попыток


size

Опционален

Объем элемента памяти в байтах.

Может быть не задан или равен 0, тогда итоговый объем памяти складывается из объемов памяти отдельных параметров


action

Опционален

Действие, которое совершается при размещения элемента памяти в лицензию, в которую уже ранее добавлялся элемент памяти с тем же самым aliasid.

По умолчанию — 0 (set)

  • 0 — set (записывает поверх);
  • 1 — owerride (переписывает новую ячейку при обновлении);
  • 2 — delete (удаляет ячейку после обновления)

crmId

ОпционаленИдентификатор в CRM системе вендора 

refId

ОпционаленИдентификатор в иных системах вендора

params

ОпционаленМассив объектов, содержащий объекты параметров яейки памяти

Описание полей объектов param в объекте params:

ПараметрОбязательностьОписаниеВозможные значения

name

ОбязателенНазвание параметра


description

ОпциональныйОписание параметра


offset

ОбязателенСмещение внутри ячейки


dataType

ОбязателенТип значения в поле data
  • 0 —  двоичный (требуется hex-редактор);
  • 1 — число (4 байта);
  • 2 — строка (UTF-8)

size

ОбязателенРазмер содержимого в байтах


editAllowed

ОбязателенФлаг, разрешающий изменение параметра


data

ОбязателенСодержимое параметра


Пример запроса
https://station.guardant.ru/v1.0/memoryitems/params
Пример тела запроса
{
	"aliasId": 26,
	"name": "item_with_params",
	"description": "item_with_params",
	"accessType": 0,
	"readPassword": 123,
	"writePassword": 456,
	"size": 50,
	"action": 0,
	"crmId": "",
	"refId": "",
    "params":[
        {
            "name": "param1",
            "description": "param1",
            "offset": 0,
            "size": 8,
            "editAllowed": true,
            "data": "111XWFlgYWI=",
            "dataType": 0
        },
        {
            "name": "param2",
            "description": "param2",
            "offset": 8,
            "size": 8,
            "editAllowed": true,
            "data": "111XWFlgYWI=",
            "dataType": 0
        }
    ]
}

Ответ

Возвращает memoryitem:

Пример результата запроса 
{
    "memoryitem": {
        "_id": 10180,
        "accesstype": 0,
        "action": 0,
        "aliasid": 26,
        "archivationdate": 0,
        "archived": false,
        "crmid": "",
        "description": "item_with_params",
        "draft": true,
        "maxaccesserrors": 5,
        "name": "item_with_params",
        "params": [
            {
                "_id": 10225,
                "data": "111XWFlgYWI=",
                "datatype": 0,
                "description": "param1",
                "editallowed": true,
                "name": "param1",
                "offset": 0,
                "size": 8
            },
            {
                "_id": 10226,
                "data": "111XWFlgYWI=",
                "datatype": 0,
                "description": "param2",
                "editallowed": true,
                "name": "param2",
                "offset": 8,
                "size": 8
            }
        ],
        "readpassword": 123,
        "refid": "",
        "size": 50,
        "totalparams_size": 16,
        "writepassword": 456
    }
}
  • No labels
Если вам нужна помощь, обратитесь по адресу
hotline@guardant.ru