5.5. Patusage (Акт применения)
Функция getRegisteredEtityNames
Описание: список всех сущностей, доступных через API
Параметры и пример POST запроса
com: getRegisteredEtityNames
opargs: {}
otype: PatUsage
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"objTypes": [
"Invoice",
"Contractor",
"WarehouseStates",
"PATBatch",
"PatProductionAct",
"Warehouse",
"PatUsagePlanRec",
"PatProduct",
"PAImportRecord",
"PatUsage",
"Inventorization",
"Acreage"]}}
Функция getEtityMD
Описание: метаданные сущности (описания атрибутов и табличных частей)
Параметры и пример POST запроса
com: getEtityMD
otype: PatUsage
opargs: {}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"cardMD": {
"_guid": "00d78949-8b9e-4f3e-81b9-b2b2ad42d01f",
"javaClassName": "fgisppa.statables.LC_BUC.BUC_210_patUsage.PatUsage",
"requiredDbExtentionsJson": "{}",
"description": "",
"tableOrCteName": "patusage",
"roleStr": "flatObject",
"pid": "",
"useValueHistory": false,
"objNameAttr": "name",
"_rectype": "obj",
"defaultListForm_className": "",
"id": "PatUsage",
"objectAccessModeStr": "noRestriction",
"packagePath": "/docs/PatUsage",
"objIdAttr": "id",
"defaultEditForm_className": "hrud.cwidgets.mdforms.Wgt_MDObject_EditForm",
"typeTitle": "Применение ПА",
"objPIdAttr": "pid",
"defaultViewForm_className": "hrud.cwidgets.mdforms.Wgt_MDObject_EditForm",
"_tparts": {
"columns": [
{
"_guid": "4970d24a-0bf6-4eeb-b5e5-215f95fc52b6",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Технический идентификатор документа во ФГИС \"Сатурн\"",
"pid": "",
"objAttr": "id",
"title": "Идентификатор документа",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": true,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_id",
"order": 10,
"dataTypeFormat": "",
"dataColumn": "id",
"objAttr_LinkedJavaClassName": "",
"dataType": "bigint",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "integer",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 70,
"_class": null,
"_id": null,
"objAttr_valueCat": "integer"
},
{
"_guid": "4a59606e-d6fa-4ab6-af3c-0b9cf5df776c",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Отображаемый в журналах заголовок документа",
"pid": "",
"objAttr": "name",
"title": "Наименование документа",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_name",
"order": 11,
"dataTypeFormat": "",
"dataColumn": "name",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar(512)",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "982209c2-f0bf-4851-a5c6-e0a3fa2347d1",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "",
"pid": "",
"objAttr": "description",
"title": "описание",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_description",
"order": 12,
"dataTypeFormat": "",
"dataColumn": "description",
"objAttr_LinkedJavaClassName": "",
"dataType": "text",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "text",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "text"
},
{
"_guid": "b178501f-b16e-4317-98ab-155697bfa445",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Фаза основного жизненного цикла",
"pid": "",
"objAttr": "lcState",
"title": "ФАЗА ЖЦ",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_lcState",
"order": 13,
"dataTypeFormat": "",
"dataColumn": "lc_state",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "dropDownEnum",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "dropDownEnum"
},
{
"_guid": "ea5a4d93-3b23-4d57-ad44-3994876ddeee",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Регистрационный номер документа, присвоенный организацией, создавшей документ",
"pid": "",
"objAttr": "docNum",
"title": "Рег. номер документа",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_docNum",
"order": 14,
"dataTypeFormat": "",
"dataColumn": "docNum",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "374e28a4-48c2-4a18-a12b-05380ed7266d",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Дата применения (дата подписания, дата утверждения, дата принятия к учету)",
"pid": "",
"objAttr": "docDate",
"title": "Дата применения",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_docDate",
"order": 15,
"dataTypeFormat": "",
"dataColumn": "docDate",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "datetimeTz",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "datetimeTz"
},
{
"_guid": "9a3c1c78-234c-4191-ac91-928a3898e5f1",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Контрагент, который является владельцем партий (юрлицо) \nкоторые списываются в использование. \nон же - занимается применением ПА.",
"pid": "",
"objAttr": "contractorId",
"title": "Организация",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "Contractor",
"id": "PatUsage_contractorId",
"order": 16,
"dataTypeFormat": "",
"dataColumn": "owner_contractor_id",
"objAttr_LinkedJavaClassName": "fgisppa.statables.LC_BUC.BUC_100_rfContractor.Contractor",
"dataType": "bigint",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "fk_number",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "fk_number"
},
{
"_guid": "1b003079-4cd2-4e23-b117-d717a984ad62",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Склад, откуда списываются ПА \nв данном случае - это фактически временный склад,\nвплоть до площадки на которой производится подготовка смеси.",
"pid": "",
"objAttr": "warehauseId",
"title": "Склад",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "Warehouse",
"id": "PatUsage_warehauseId",
"order": 17,
"dataTypeFormat": "",
"dataColumn": "warehause_id",
"objAttr_LinkedJavaClassName": "fgisppa.statables.LC_BUC.BUC_130_rfWarehouse.Warehouse",
"dataType": "bigint",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "fk_number",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "fk_number"
},
{
"_guid": "7b987aed-9701-40a2-9de7-d16594834f3e",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Способ применения ПА",
"pid": "",
"objAttr": "applicationMethod",
"title": "Способ применения ПА",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_applicationMethod",
"order": 18,
"dataTypeFormat": "",
"dataColumn": "application_method",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "dropDownEnum",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "dropDownEnum"
},
{
"_guid": "2c79e45d-a646-4757-a7ab-6bce62202dd6",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Регион присвоенный документу по месту применения, или по складу источнику ПА, если место применения не является 'зарегистрированным местом'. \nПрисваивается в момент 'актуализации'.",
"pid": "",
"objAttr": "region",
"title": "Регион",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_region",
"order": 19,
"dataTypeFormat": "",
"dataColumn": "region",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "2a134b95-598b-4022-96ca-12c780f4d6dc",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Примечание/описание к документу \n не путать\tс sys_note (замечания к записи).",
"pid": "",
"objAttr": "docNote",
"title": "Примечание к документу",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "PatUsage_docNote",
"order": 20,
"dataTypeFormat": "",
"dataColumn": "doc_note",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 250,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "9b12a548-1447-4664-b35e-3f8fd1a5b170",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Время создания записи.\nПри использовании datavault - время создания данного набора записей.\nПри использовании datavault - является частью группового первичного ключа\nТехнический формат : long, unix time, millisecs.",
"pid": "",
"objAttr": "sys_timeFrom",
"title": "(sys) timeFrom",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_timeFrom",
"order": 1000,
"dataTypeFormat": "",
"dataColumn": "sys_timefrom",
"objAttr_LinkedJavaClassName": "",
"dataType": "bigint",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "integer",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "integer"
},
{
"_guid": "35c4a748-7ea3-4b27-975d-038ce46e81f1",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Время окончания актуальности записи. \nЕсли datavault не используется - является достаточным признаком того, что данная запись 'помечена на удаление', и ее следует обрабатывать как 'несушестввующую'и в ближайшем времени - удалить физически. \nПри использовании datavault - время замены данного набора записей следующей версией.\nТехнический формат : long, unix time, millisecs.",
"pid": "",
"objAttr": "sys_timeTo",
"title": "(sys) timeTo",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_timeTo",
"order": 1001,
"dataTypeFormat": "",
"dataColumn": "sys_timeto",
"objAttr_LinkedJavaClassName": "",
"dataType": "bigint",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "integer",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "integer"
},
{
"_guid": "de2d489e-3b92-476c-b3eb-4bc7709d0f6b",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Время модификации записи.\nПри использовании datavault - всегда равно timeFrom или timeTo. \nЗаполняется при начале транзакции из System.currentTimeMillis() \nТехнический формат : long, unix time, millisecs.",
"pid": "",
"objAttr": "sys_changedAt",
"title": "(sys) time ChangeAt",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_changedAt",
"order": 1002,
"dataTypeFormat": "",
"dataColumn": "sys_changedat",
"objAttr_LinkedJavaClassName": "",
"dataType": "bigint",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "integer",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "integer"
},
{
"_guid": "d444c4c2-7d0e-4a0a-bfd7-61d7a5591fb2",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Автор последнего изменения, логин пользоватлея. \nПри использовании datavault - всегда равен автору создавшему данный набор аириьбутов (т.е. не подменяется на того, кто создал следующую ерсию)\n",
"pid": "",
"objAttr": "sys_authorId",
"title": "(sys) authorId",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_authorId",
"order": 1003,
"dataTypeFormat": "",
"dataColumn": "sys_authorid",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "5952c391-003f-4d31-aba0-4742bd59f942",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Идентификатор родительской записи , которая является 'каталогом' в который входит данная запись \n\n",
"pid": "",
"objAttr": "pid",
"title": "(std) parent id",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_pid",
"order": 1004,
"dataTypeFormat": "",
"dataColumn": "pid",
"objAttr_LinkedJavaClassName": "",
"dataType": "bigint",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "integer",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 150,
"_class": null,
"_id": null,
"objAttr_valueCat": "integer"
},
{
"_guid": "242f6fde-7602-4b29-b432-c6b57f9d6d7a",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Является этот элелемнт каталогом или листовым элементом.\nв основном определяет то, какой иконкой оображается элемент. буедт Если логикой не определено, \n\n",
"pid": "",
"objAttr": "is_folder",
"title": "(std) is folder",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_is_folder",
"order": 1005,
"dataTypeFormat": "",
"dataColumn": "is_folder",
"objAttr_LinkedJavaClassName": "",
"dataType": "boolean",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "bool",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 50,
"_class": null,
"_id": null,
"objAttr_valueCat": "bool"
},
{
"_guid": "e092a504-9669-4748-a9fa-37f4f0f0f75a",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Заметка к записи. \nПри использовании datavault - допускается обновление данного атрибута без создания версии.\n",
"pid": "",
"objAttr": "sys_note",
"title": "(sys) note",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_note",
"order": 1005,
"dataTypeFormat": "",
"dataColumn": "sys_note",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "9894288d-f296-45d8-836b-9a94b4f99b19",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "GUID _объекта_. \nАналогично ID, но необходим при обмене данными между источниками. \nпо сути, это должна быть просто гарантирвоанно уникальная строка описывающая объект, запись.Т.е. допускется формировать 'расширенный-гуид' с доп.суффиксами. например '{1234-2332-23232}/23' или '1234-2332-23232/23-23-23' \nПри использовании datavault - требует установки сразу при создании объекта - как и id.\n",
"pid": "",
"objAttr": "sys_guid",
"title": "(sys) guid",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_guid",
"order": 1006,
"dataTypeFormat": "",
"dataColumn": "sys_guid",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 70,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "19858dd9-2ce4-40c2-adcc-fd9385a51a80",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Класс который 'владеет' данной записью как элементом табличной части или агрегированым объектом. \nможет быть пустым если не подразумевается владение разными классами.\n",
"pid": "",
"objAttr": "sys_ownerClass",
"title": "(sys) owner class",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_ownerClass",
"order": 1007,
"dataTypeFormat": "",
"dataColumn": "sys_ownerclass",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "fc698a9f-dcc3-43e1-864a-4d85424e3c34",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Идентификатор записи, которая 'владеет' данной записью - как элементом табличной части или агрегированым объектом.\n\n",
"pid": "",
"objAttr": "sys_ownerId",
"title": "(sys) owner id",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_ownerId",
"order": 1008,
"dataTypeFormat": "",
"dataColumn": "sys_ownerid",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "cbd2c3af-c59d-4b94-af99-61d47a713b50",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Идентификатор имени списка (или имя табличной части) - в которую входит данная запись.\n\n",
"pid": "",
"objAttr": "sys_ownerListName",
"title": "(sys) owner list",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_ownerListName",
"order": 1008,
"dataTypeFormat": "",
"dataColumn": "sys_ownerlistname",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "0dfcd7a3-6609-4de6-885c-a3f3077d3994",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "\n",
"pid": "",
"objAttr": "sys_order",
"title": "(sys) line order",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_order",
"order": 1009,
"dataTypeFormat": "",
"dataColumn": "sys_order",
"objAttr_LinkedJavaClassName": "",
"dataType": "integer",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "integer",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "integer"
},
{
"_guid": "ac97e93a-2112-47f1-82d3-adb35d2d9121",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "Системный атриут. Номер версии объекта. автоинкрементный счетчик, увеличивающийся на 1. Существует как базовый механизм защиты от параллельной правки - ORM заблокирует запись объекта, если номер версии объекта который вы предлагаете и тот, который в БД не совпадают.Так же, позволяет обнаруживать признак изменения объекта в БД для целей синхронизации.\nПо умолчанию отключен. для активации необходмо установить в MD.versionControlLevel = VC_Level.series",
"pid": "",
"objAttr": "sys_ver",
"title": "(sys) ver number",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_ver",
"order": 1010,
"dataTypeFormat": "",
"dataColumn": "sys_ver",
"objAttr_LinkedJavaClassName": "",
"dataType": "integer",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "integer",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "integer"
},
{
"_guid": "e44cbffa-c32e-4f9e-b9b5-1f05faf1656d",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "наименование (строковой код) системы-источника, откуда получена карточка\n",
"pid": "",
"objAttr": "sys_recSource",
"title": "(sys) record source",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_recSource",
"order": 1011,
"dataTypeFormat": "",
"dataColumn": "sys_recsource",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "780d6333-fcd5-499c-ab94-f5444d0c6e37",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "краткое наименование класса владельца. в зависимости от сущности или подсистемы это могут быть разные карточки.\n",
"pid": "",
"objAttr": "sys_rwx_ownerClass",
"title": "(sys) rwx-owner class",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_rwx_ownerClass",
"order": 1011,
"dataTypeFormat": "",
"dataColumn": "sys_rwx_ownerclass",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "244d71c6-4191-401e-8a07-e10409000130",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "краткое наименование класса группы владельца. в зависимости от сущности или подсистемы это могут быть разные карточки.\n",
"pid": "",
"objAttr": "sys_rwx_ownerGroupClass",
"title": "(sys) rwx-owner-group class",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_rwx_ownerGroupClass",
"order": 1011,
"dataTypeFormat": "",
"dataColumn": "sys_rwx_ownergroupclass",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "92a35ffc-6ebd-43b7-8595-5d6a62ad0b69",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "группа-владелец, или владельцы карточки (через пробел, с начальным и конечным пробелом). как правило присваются при создании. логика назначения и анализа может отличаться от сущности к сущности\n",
"pid": "",
"objAttr": "sys_rwx_ownerGroupIds",
"title": "(sys) rwx-owner-group",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_rwx_ownerGroupIds",
"order": 1011,
"dataTypeFormat": "",
"dataColumn": "sys_rwx_ownergroupids",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
},
{
"_guid": "c7bb0678-820f-40f7-bb94-867a1f7ddc24",
"autoincrementStartFrom": 1000,
"timeTo": 9.223372036854776E18,
"description": "id владельца, или владельцы карточки (через пробел, с начальным и конечным пробелом). как правило присваются при создании. \nлогика назначения и анализа может отличаться от сущности к сущности\n",
"pid": "",
"objAttr": "sys_rwx_ownerIds",
"title": "(sys) rwx-owner",
"_rectype": "obj",
"isReadOnly": false,
"autoincrement": false,
"objAttr_LinkedTypeId_default": "",
"id": "null_sys_rwx_ownerIds",
"order": 1011,
"dataTypeFormat": "",
"dataColumn": "sys_rwx_ownerids",
"objAttr_LinkedJavaClassName": "",
"dataType": "varchar",
"objAttr_LinkedEnumClassName": "",
"isHidden": false,
"timeFrom": -9.223372036854776E18,
"_tparts": {},
"_FORMAT_VER": "2021.09.25_0430",
"dataIndexName": "string",
"_FORMAT": "HRJSON",
"isNullable": false,
"width": 0,
"_class": null,
"_id": null,
"objAttr_valueCat": "string"
}
]
},
"_FORMAT_VER": "2021.09.25_0430",
"strictBeanMode": true,
"_FORMAT": "HRJSON",
"vCLevelStr": "none",
"defaultSelectForm_className": "",
"typeId": "PatUsage",
"mdRecordType": "DB-Table MD",
"_class": null,
"_id": null,
"objListTitle": "Применение ПА"
}
}
}
Функция getEtityLCNames
Описание: Список жизненных циклов
Параметры и пример POST запроса
com: getEtityLCNames
otype: PatUsage
opargs: {}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"lifeCycles": [
"mainlc"
]
}
}
Функция getEtityLC
Описание: Список состояний(фаз)у ЖЦ [mainlc]
Параметры и пример POST запроса
com: getEtityLC
otype: PatUsage
opargs: {}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"targetObjAttr": null,
"targetClass": "class fgisppa.statables.LC_BUC.BUC_210_patUsage.PatUsage",
"lifeCycleName": "mainlc",
"startState": "draft",
"states": [
{
"stateName": "actual",
"title": "актуально",
"operations": [
{
"operationName": "actual/undoSetActual()",
"title": "отмена операции принятия к учету",
"description": "перевести карточку в состояние 'черновик' (из актуального).",
"args": [],
"results": []
},
{
"operationName": "actual/setArchived()",
"title": "в архив",
"description": "перевести карточку в состояние архив - устаревшая или уже не актуальная информация.",
"args": [],
"results": []
}
]
},
{
"stateName": "archived",
"title": "архив",
"operations": []
},
{
"stateName": "canceled",
"title": "архив",
"operations": []
},
{
"stateName": "[static]",
"title": "[статические операции]",
"operations": [
{
"operationName": "static/getList()",
"title": "просмотреть список",
"description": "отдает перечень заголовокв объектов объектов",
"args": [
{
"argName": "pos",
"titlle": "смещение, начало",
"description": "смещение начала списка, c нуля,\nпо умолчанию 0",
"type": "int",
"typeSpecs": null
},
{
"argName": "size",
"titlle": "длина списка",
"description": "длина списка, от единицы. \nпо умолчанию (если не указано) 100, минимум 2, максимум 500",
"type": "int",
"typeSpecs": null
},
{
"argName": "getFullCards",
"titlle": "полные карточки?",
"description": "1 - возвращать полносериалихованные карточки в objList, или 0 - только перечень атрибутов, в attrTable \n по умолчанию 1",
"type": "int",
"typeSpecs": null
},
{
"argName": "filters",
"titlle": "фильтры",
"description": "Json String, json array объектов описанием условий фильтра. например \"[ {'column':'colName','condition':'=','value':'value'}, {...}, ..., {...}]\". при этом value может быть числом, строкой, или массивом строк или чисел. перечисленные условия объединяются по AND.",
"type": "String",
"typeSpecs": null
},
{
"argName": "orderBy",
"titlle": "колонки сортировки",
"description": "Json String, json array строк с именами колонок. например \"['colNameA','colNameB', ... , 'colNameZ']\"",
"type": "String",
"typeSpecs": null
}
],
"results": [
{
"retName": "objList",
"titlle": "список объектов",
"description": "'связанный' json-массив HRJSON-объектов (глубокая сериализация сущностей с агрегацией всех ссылочных объектов).\nотдается, если не отдается attrTable",
"type": "String"
},
{
"retName": "attrTable",
"titlle": "таблица атрибутов",
"description": "JSON массив, 2-мерный. Первая строка - это имена заголовков. в конец добалвются колонки с суффиксами '__NAME' для указания имен ссылочных объектов.\nотдается, если не отдается objList",
"type": "String"
}
]
},
{
"operationName": "static/createNew()",
"title": "создать объект",
"description": "конструктор нового объекта",
"args": [],
"results": [
{
"retName": "objList",
"titlle": "список объектов, 1 объект",
"description": "Объект который создан'связанный' json-массив HRJSON-объектов (глубокая сериализация сущностей с агрегацией всех ссылочных объектов).\nотдается, если не отдается attrTable",
"type": "String"
}
]
}
]
},
{
"stateName": "draft",
"title": "черновик",
"operations": [
{
"operationName": "draft/updateCard()",
"title": "изменить карточку сущности",
"description": "Команда для изменения структуры объекта имеющегося на сервере - обновления полей (в том числе и частичного), \n добавления или удаления строк табличной части и пр. \n Все присылаемые id должны соответствовать тем, что уже есть на сервере.\n",
"args": [
{
"argName": "theCard",
"titlle": "карточка объекта",
"description": "Карточка объекта, сериализованная в HRJSON,\nили простой JSON объект с именами полей равными изменяемым атрибутам объекта,\n\nВо всех json-объектах обязательными являются 2 поля : \n * '_class' с полным именем java-класса (пакеты и имя класса),\n * '_id' c идентификатором объекта в хранилищах бизнес-слоя. \n\nТабличные части передаются в поле '_tparts' - это должен быть json-объект, \nс полями равными именам табличных частей, в которых лежат массивы объектов с даннвми строк табличных частей.\n\nПри разборе значений анализируются значения только первого уровня, \nт.е. их непосредственные значения (а для вложенных hr-json объектов в FK-полях - поле '_id') \nВложенные hr-json объекты не создаются! \n\nДОБАВНИЕ СТРОК ТЧ: Если объект в ТЧ приведен с '_id'='-1' - строка табличной части будет создана.\n\nУДАЛЕНИЕ СТРОК ТЧ: Если объект в ТЧ приведен с существующим '_id', но \nи присутствует спец атрибут '_toDelete' со значением 'true' - значит \nстрока ТЧ будет удалена. \n\nПРОПУСК СТРОК ТЧ: Если строка в ТЧ приведена (есть '_id' и '_class'), \nно не приводятся атриубты - значит объект меняться не будет, и не будет удаляться.\n\nЕсли строка в ТЧ не приведена (объект пропущен), \nстрока в ТЧ не будет обновляться, и не будет удаляться.\n\nТаким образом, имеет смысл приводить только изменяемые/обновляемые строки в ТЧ.\n\nПеречни атрибутов рассматриваются как те которые моно изменять. \nЕсли атрибуты будут пропущены, они не будут изменены.\n\nНа список допустимых для обновления атрибутов и возможность добавлять/убитрать строки табличной части,\nмогут быть наложены ограничения - см .typeSpecs аргумента theCard",
"type": "commons.storages.flatObjects.AMDObject",
"typeSpecs": [
"*",
"*[]+-",
"*[].*"
]
},
{
"argName": "comment",
"titlle": "Комментарий к операции",
"description": "заметки оператора, о том, зачем он совершает эту операцию,\n",
"type": "String",
"typeSpecs": null
}
],
"results": []
},
{
"operationName": "draft/setActual()",
"title": "в работу",
"description": "перевести карточку в состояние 'актуально' - актуальная информация для применения.",
"args": [],
"results": []
},
{
"operationName": "draft/setCanceled()",
"title": "отменить черновик",
"description": "перевести карточку в состояние 'отменено' - информация которая не была в работе, или признана ошибочно заведенной.",
"args": [],
"results": []
}
]
},
{
"stateName": "[any]",
"title": "[все состояния]",
"operations": [
{
"operationName": "any/getFullCard()",
"title": "получить полную карточку сущности",
"description": "отдает 'глубокую сериализаци' карточки сущности",
"args": [],
"results": []
},
{
"operationName": "any/clone()",
"title": "скопировтаь объект",
"description": "создает копию записи, в отношении которой был вызван в состоянии черновик",
"args": [],
"results": [
{
"retName": "objList",
"titlle": "список объектов, 1 объект",
"description": "Объект который был создан'связанный' json-массив HRJSON-объектов (глубокая сериализация сущностей с агрегацией всех ссылочных объектов).\n",
"type": "HrJson"
}
]
},
{
"operationName": "any/getPrintForm()",
"title": "получить печатную форму карточки",
"description": "отдает печатную форму карточки в формате excel",
"args": [],
"results": []
}
]
}
]
}
}
Функция getEtityLC
Описание: Список операций для состояния (draft)
Параметры и пример POST запроса
com: getEtityLC
otype: PatUsage
opargs: {}
lcstate: draft
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"targetObjAttr": null,
"targetClass": "class fgisppa.statables.LC_BUC.BUC_210_patUsage.PatUsage",
"lifeCycleName": "mainlc",
"startState": "draft",
"states": [
{
"stateName": "draft",
"title": "черновик",
"operations": [
{
"operationName": "draft/updateCard()",
"title": "изменить карточку сущности",
"description": "Команда для изменения структуры объекта имеющегося на сервере - обновления полей (в том числе и частичного), \n добавления или удаления строк табличной части и пр. \n Все присылаемые id должны соответствовать тем, что уже есть на сервере.\n",
"args": [
{
"argName": "theCard",
"titlle": "карточка объекта",
"description": "Карточка объекта, сериализованная в HRJSON,\nили простой JSON объект с именами полей равными изменяемым атрибутам объекта,\n\nВо всех json-объектах обязательными являются 2 поля : \n * '_class' с полным именем java-класса (пакеты и имя класса),\n * '_id' c идентификатором объекта в хранилищах бизнес-слоя. \n\nТабличные части передаются в поле '_tparts' - это должен быть json-объект, \nс полями равными именам табличных частей, в которых лежат массивы объектов с даннвми строк табличных частей.\n\nПри разборе значений анализируются значения только первого уровня, \nт.е. их непосредственные значения (а для вложенных hr-json объектов в FK-полях - поле '_id') \nВложенные hr-json объекты не создаются! \n\nДОБАВНИЕ СТРОК ТЧ: Если объект в ТЧ приведен с '_id'='-1' - строка табличной части будет создана.\n\nУДАЛЕНИЕ СТРОК ТЧ: Если объект в ТЧ приведен с существующим '_id', но \nи присутствует спец атрибут '_toDelete' со значением 'true' - значит \nстрока ТЧ будет удалена. \n\nПРОПУСК СТРОК ТЧ: Если строка в ТЧ приведена (есть '_id' и '_class'), \nно не приводятся атриубты - значит объект меняться не будет, и не будет удаляться.\n\nЕсли строка в ТЧ не приведена (объект пропущен), \nстрока в ТЧ не будет обновляться, и не будет удаляться.\n\nТаким образом, имеет смысл приводить только изменяемые/обновляемые строки в ТЧ.\n\nПеречни атрибутов рассматриваются как те которые моно изменять. \nЕсли атрибуты будут пропущены, они не будут изменены.\n\nНа список допустимых для обновления атрибутов и возможность добавлять/убитрать строки табличной части,\nмогут быть наложены ограничения - см .typeSpecs аргумента theCard",
"type": "commons.storages.flatObjects.AMDObject",
"typeSpecs": [
"*",
"*[]+-",
"*[].*"
]
},
{
"argName": "comment",
"titlle": "Комментарий к операции",
"description": "заметки оператора, о том, зачем он совершает эту операцию,\n",
"type": "String",
"typeSpecs": null
}
],
"results": []
},
{
"operationName": "draft/setActual()",
"title": "в работу",
"description": "перевести карточку в состояние 'актуально' - актуальная информация для применения.",
"args": [],
"results": []
},
{
"operationName": "draft/setCanceled()",
"title": "отменить черновик",
"description": "перевести карточку в состояние 'отменено' - информация которая не была в работе, или признана ошибочно заведенной.",
"args": [],
"results": []
}
]
}
]
}
}
Функция getEtityLC
Описание: Аргументы операции, ЖЦ [mainlc], операция [draft/updateCard()]
Параметры и пример POST запроса
com: getEtityLC
otype: PatUsage
opargs: {}
lcstate: draft
lcop: draft/updateCard()
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"targetObjAttr": null,
"targetClass": "class fgisppa.statables.LC_BUC.BUC_210_patUsage.PatUsage",
"lifeCycleName": "mainlc",
"startState": "draft",
"states": [
{
"stateName": "draft",
"title": "черновик",
"operations": [
{
"operationName": "draft/updateCard()",
"title": "изменить карточку сущности",
"description": "Команда для изменения структуры объекта имеющегося на сервере - обновления полей (в том числе и частичного), \n добавления или удаления строк табличной части и пр. \n Все присылаемые id должны соответствовать тем, что уже есть на сервере.\n",
"args": [
{
"argName": "theCard",
"titlle": "карточка объекта",
"description": "Карточка объекта, сериализованная в HRJSON,\nили простой JSON объект с именами полей равными изменяемым атрибутам объекта,\n\nВо всех json-объектах обязательными являются 2 поля : \n * '_class' с полным именем java-класса (пакеты и имя класса),\n * '_id' c идентификатором объекта в хранилищах бизнес-слоя. \n\nТабличные части передаются в поле '_tparts' - это должен быть json-объект, \nс полями равными именам табличных частей, в которых лежат массивы объектов с даннвми строк табличных частей.\n\nПри разборе значений анализируются значения только первого уровня, \nт.е. их непосредственные значения (а для вложенных hr-json объектов в FK-полях - поле '_id') \nВложенные hr-json объекты не создаются! \n\nДОБАВНИЕ СТРОК ТЧ: Если объект в ТЧ приведен с '_id'='-1' - строка табличной части будет создана.\n\nУДАЛЕНИЕ СТРОК ТЧ: Если объект в ТЧ приведен с существующим '_id', но \nи присутствует спец атрибут '_toDelete' со значением 'true' - значит \nстрока ТЧ будет удалена. \n\nПРОПУСК СТРОК ТЧ: Если строка в ТЧ приведена (есть '_id' и '_class'), \nно не приводятся атриубты - значит объект меняться не будет, и не будет удаляться.\n\nЕсли строка в ТЧ не приведена (объект пропущен), \nстрока в ТЧ не будет обновляться, и не будет удаляться.\n\nТаким образом, имеет смысл приводить только изменяемые/обновляемые строки в ТЧ.\n\nПеречни атрибутов рассматриваются как те которые моно изменять. \nЕсли атрибуты будут пропущены, они не будут изменены.\n\nНа список допустимых для обновления атрибутов и возможность добавлять/убитрать строки табличной части,\nмогут быть наложены ограничения - см .typeSpecs аргумента theCard",
"type": "commons.storages.flatObjects.AMDObject",
"typeSpecs": [
"*",
"*[]+-",
"*[].*"
]
},
{
"argName": "comment",
"titlle": "Комментарий к операции",
"description": "заметки оператора, о том, зачем он совершает эту операцию,\n",
"type": "String",
"typeSpecs": null
}
],
"results": []
}
]
}
]
}
}
Функция getEntityStates
Описание: Состояния заданной сущности
Параметры и пример POST запроса
com: getEntityStates
otype: PatUsage
oid: 1575092
opargs: {}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"states": {
"mainlc": "actual"
}
}
}
Функция getAllowedEntityOpereations
Описание: доступные операции у заданной сущности (зависит от состояния сущности)
Параметры и пример POST запроса
com: getAllowedEntityOpereations
otype: PatUsage
oid: 1575092
opargs: {}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"lifeCycleOperations": {
"mainlc": [
"actual/undoSetActual()",
"actual/setArchived()",
"static/getList()",
"static/createNew()",
"any/getFullCard()",
"any/clone()",
"any/getPrintForm()"
]
}
}
}
Функция static/getList() без фильтра
Описание атрибутов операции static/getList() приведено в таблице ниже.
Таблица – Описание атрибутов операции static/getList()
| № | Параметр | Тип данных | Обязательность заполнения |
Описание | Примеры значений |
|---|---|---|---|---|---|
| Основные параметры запроса | |||||
| 1 | pos | Число | Нет | Cмещение начала списка | Значение по умолчанию: 0 |
| 2 | size | Число | Нет | Длина списка | Значение по умолчанию: 1, максимальное значение: 100 |
| 3 | getFullCards | Число | Да | Вариант получения данных | 0 - отдает json-массив
1 – отдает полные карточки с глубокой сериализацией как при getFullCard() |
| 4 | filters | Массив объектов | Да | Фильтр | JSON String, JSON array объектов c описанием условий фильтра, например: "[{'column':'colName','condition':'=','value':'value'}, {...}, ..., {...}]", при этом value может быть числом, строкой или массивом строк или чисел. Перечисленные условия объединяются по AND. |
Описание: получить список с фильтром
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
op: static/getList()
opargs: {
"pos": 0,
"size": 100,
"getFullCards": 0,
"filters": []}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"attrTable": [
[
"id",
"docNum",
"docDate",
"name",
"lcState",
"contractorId",
"warehauseId",
"applicationMethod",
"region",
"docNote",
"sysGuid",
"sysTimeFrom",
"sysChangedAt",
"contractorIdName",
"warehauseIdName"
],
[
"1691371",
"",
"",
"Обработка сельскохозяственных угодий",
"actual",
"",
"",
"",
"",
"",
"",
"1738574291985",
"",
"",
""
],
[
"1691358",
"",
"",
"Обработка сельскохозяственных угодий",
"actual",
"",
"",
"",
"",
"",
"",
"1738254485322",
"",
"",
""
],
[
"1691372",
"",
"",
"Обработка сельскохозяственных угодий",
"draft",
"",
"",
"",
"",
"",
"",
"1738587588561",
"",
"",
""
],
[
"1691359",
"",
"",
"Обработка сельскохозяственных угодий",
"draft",
"",
"",
"",
"",
"",
"",
"1738254930273",
"",
"",
""
],
[
"1691368",
"",
"",
"Обработка сельскохозяственных угодий",
"draft",
"",
"",
"",
"",
"",
"",
"1738329649971",
"",
"",
""
]
]
}
}
Функция static/getList() с простым фильтром
Описание атрибутов операции static/getList() приведено в таблице ниже.
Таблица – Описание атрибутов операции static/getList()
| № | Параметр | Тип данных | Обязательность заполнения |
Описание | Примеры значений |
|---|---|---|---|---|---|
| Основные параметры запроса | |||||
| 1 | pos | Число | Нет | Cмещение начала списка | Значение по умолчанию: 0 |
| 2 | size | Число | Нет | Длина списка | Значение по умолчанию: 1, максимальное значение: 100 |
| 3 | getFullCards | Число | Да | Вариант получения данных | 0 - отдает json-массив
1 – отдает полные карточки с глубокой сериализацией как при getFullCard() |
| 4 | filters | Массив объектов | Да | Фильтр | JSON String, JSON array объектов c описанием условий фильтра, например: "[{'column':'colName','condition':'=','value':'value'}, {...}, ..., {...}]", при этом value может быть числом, строкой или массивом строк или чисел. Перечисленные условия объединяются по AND. |
| Фильтры (filters) | |||||
| 1 | column | Строка | Да | Колонка | name |
| 2 | condition | Строка | Да | Логический оператор | like |
| 3 | value | Строка | Да | Значение | %овая% |
Описание: получить список с фильтром
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
op: static/getList()
opargs: {"pos": 0,
"size": 100,
"getFullCards": 1,
"filters": [
{
"column": "id",
"condition": "=",
"value": 1691358 }]}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"objList": {
"_FORMAT_VER": "2021.09.25_0430",
"_rectype": "array",
"_OBJ_ARRAY": [
{
"sys_timeTo": "9223372036854775807",
"sys_note": "2025-02-03T13:32:47.473576215+03:00 draft/setActual() pechenev_an_020518869::2025-01-30T19:28:05.322727841+03:00 createDraft() pechenev_an_020518869",
"docNum": "123",
"lcState": "actual",
"_guid": null,
"contractor_id": "1",
"sys_recSource": null,
"description": "",
"pid": null,
"sys_authorId": null,
"sys_rwx_ownerGroupIds": null,
"_rectype": null,
"sys_ownerClass": null,
"sys_changedAt": "1738578767473",
"sys_ver": null,
"sys_guid": null,
"sys_order": null,
"id": "1691358",
"sys_rwx_ownerClass": "Contractor",
"sys_ownerId": null,
"is_folder": null,
"docDate": "2025-01-30T16:27:31.784Z",
"warehauseId": null,
"sys_ownerListName": null,
"sys_rwx_ownerGroupClass": null,
"_tparts": {
"tbrBatchInfo": [
{
"id": 4147973,
"name": null,
"description": null,
"patProductId": 1000,
"batchId": 5600000,
"batchCodes": "1",
"batchBoxCodes": null,
"puUnit": "бочка",
"puKgWeight": 50,
"countPu": 1000,
"applDosage": "123",
"acreageId": 1500246,
"countNetto": 50000,
"sysTimeFrom": 1738254485322,
"sysTimeTo": 9223372036854775807,
"sysChangeDat": 1738254485322,
"sysAuthorId": null,
"pid": null,
"isFolder": null,
"sysNote": "2025-01-30T19:28:05.322727841+03:00 createDraft() pechenev_an_020518869",
"sysGuid": null,
"sysOwnerClass": "PatUsage",
"sysOwnerId": 1691358,
"sysOwnerListName": "PatUsage_tbr_BatchInfo",
"sysOrder": 0,
"sysVer": null,
"sysRecsource": null,
"sysRwxOwnerClass": null,
"sysRwxOwnerGroupClass": null,
"sysRwxOwnerGroupIds": null,
"sysRwxOwnerIds": null,
"tbrPlacesInfoId": 85491000,
"patProductName": "2,4-Дактив",
"activeContent": null,
"credit": null,
"okeiCode": null,
"price": null,
"aplOnArea": null,
"countNettoApply": null,
"activeTotal": null,
"totalPrice": null
}
],
"tbrPlacesInfo": [
{
"id": 85491000,
"name": "01609-573 Подсолнечник",
"description": null,
"placeType": null,
"acreageId": 1500246,
"placeDescription": null,
"agricultureDescription": "Подсолнечник",
"area": 19.4502715205431,
"weightMultiplier": null,
"sysTimeFrom": 1738254485322,
"sysTimeTo": 9223372036854775807,
"sysChangeDat": 1738254485322,
"sysAuthorId": null,
"pid": null,
"isFolder": null,
"sysNote": "2025-01-30T19:28:05.322727841+03:00 createDraft() pechenev_an_020518869",
"sysGuid": null,
"sysOwnerClass": "PatUsage",
"sysOwnerId": 1691358,
"sysOwnerListName": "PatUsage_tbr_PlacesInfo",
"sysOrder": 0,
"sysVer": null,
"sysRecsource": null,
"sysRwxOwnerClass": null,
"sysRwxOwnerGroupClass": null,
"sysRwxOwnerGroupIds": null,
"sysRwxOwnerIds": null,
"efisLocalCode": "01609-573"
}
]
},
"_FORMAT_VER": null,
"_FORMAT": null,
"name": "Обработка сельскохозяственных угодий",
"applicationMethod": null,
"sys_rwx_ownerIds": "1",
"sys_timeFrom": "1738254485322",
"_class": "PatUsage",
"docNote": null,
"region": null
}
],
"_FORMAT": "HRJSON"
}
}
}
Функция static/getList() с фильтром группой
Описание атрибутов операции static/getList() приведено в таблице ниже.
Таблица 3 – Описание атрибутов операции static/getList()
| № | Параметр | Тип данных | Обязательность заполнения |
Описание | Примеры значений |
|---|---|---|---|---|---|
| Основные параметры запроса | |||||
| 1 | pos | Число | Нет | Cмещение начала списка | Значение по умолчанию: 0 |
| 2 | size | Число | Нет | Длина списка | Значение по умолчанию: 1, максимальное значение: 100 |
| 3 | getFullCards | Число | Да | Вариант получения данных | 0 - отдает json-массив
1 – отдает полные карточки с глубокой сериализацией как при getFullCard() |
| 4 | filters | Массив объектов | Да | Фильтр | JSON String, JSON array объектов c описанием условий фильтра, например: "[{'column':'colName','condition':'=','value':'value'}, {...}, ..., {...}]", при этом value может быть числом, строкой или массивом строк или чисел. Перечисленные условия объединяются по AND. |
| Фильтры (filters) | |||||
| 1 | condition | Строка | Да | Логический оператор | and |
| 2 | filters | Массив объектов | Да | Фильтр | JSON String, JSON array объектов c описанием условий фильтра, например: "[{'column':'colName','condition':'=','value':'value'}, {...}, ..., {...}]", при этом value может быть числом, строкой или массивом строк или чисел. Перечисленные условия объединяются по AND. |
| Вложенные фильтры | |||||
| 1 | column | Строка | Да | Колонка | id |
| 2 | condition | Строка | Да | Логический оператор | = |
| 3 | value | Строка | Да | Значение | 1691359 |
Описание: получить список с фильтром
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
op: static/getList()
opargs: {
"pos": 0,
"size": 100,
"getFullCards": 0,
"filters": [
{
"condition": "and",
"filters": []
},
{
"column": "id",
"condition": "=",
"value": [
"1691358",
"10503",
"1691359"
]
}
]
}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"attrTable": [
[
"id",
"docNum",
"docDate",
"name",
"lcState",
"contractorId",
"warehauseId",
"applicationMethod",
"region",
"docNote",
"sysGuid",
"sysTimeFrom",
"sysChangedAt",
"contractorIdName",
"warehauseIdName"
],
[
"1691358",
"",
"",
"Обработка сельскохозяственных угодий",
"actual",
"",
"",
"",
"",
"",
"",
"1738254485322",
"",
"",
""
],
[
"1691359",
"",
"",
"Обработка сельскохозяственных угодий",
"draft",
"",
"",
"",
"",
"",
"",
"1738254930273",
"",
"",
""
]
]
}
}
Функция any/getFullCard()
Описание: получить карточку
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
oid: 1691358
op: any/getFullCard()
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Пример ответа сервера:
{
"transId": null,
"resCode": 200,
"reqPerMin": null,
"resMsg": null,
"resDescription": null,
"resData": {
"objList": {
"_FORMAT_VER": "2021.09.25_0430",
"_rectype": "array",
"_OBJ_ARRAY": [
{
"sys_timeTo": "9223372036854775807",
"sys_note": "2025-02-03T13:32:47.473576215+03:00 draft/setActual() pechenev_an_020518869::2025-01-30T19:28:05.322727841+03:00 createDraft() pechenev_an_020518869",
"docNum": "123",
"lcState": "actual",
"_guid": null,
"contractor_id": "1",
"sys_recSource": null,
"description": "",
"pid": null,
"sys_authorId": null,
"sys_rwx_ownerGroupIds": null,
"_rectype": null,
"sys_ownerClass": null,
"sys_changedAt": "1738578767473",
"sys_ver": null,
"sys_guid": null,
"sys_order": null,
"id": "1691358",
"sys_rwx_ownerClass": "Contractor",
"sys_ownerId": null,
"is_folder": null,
"docDate": "2025-01-30T16:27:31.784Z",
"warehauseId": null,
"sys_ownerListName": null,
"sys_rwx_ownerGroupClass": null,
"_tparts": {
"tbrBatchInfo": [
{
"id": 4147973,
"name": null,
"description": null,
"patProductId": 1000,
"batchId": 5600000,
"batchCodes": "1",
"batchBoxCodes": null,
"puUnit": "бочка",
"puKgWeight": 50,
"countPu": 1000,
"applDosage": "123",
"acreageId": 1500246,
"countNetto": 50000,
"sysTimeFrom": 1738254485322,
"sysTimeTo": 9223372036854775807,
"sysChangeDat": 1738254485322,
"sysAuthorId": null,
"pid": null,
"isFolder": null,
"sysNote": "2025-01-30T19:28:05.322727841+03:00 createDraft() pechenev_an_020518869",
"sysGuid": null,
"sysOwnerClass": "PatUsage",
"sysOwnerId": 1691358,
"sysOwnerListName": "PatUsage_tbr_BatchInfo",
"sysOrder": 0,
"sysVer": null,
"sysRecsource": null,
"sysRwxOwnerClass": null,
"sysRwxOwnerGroupClass": null,
"sysRwxOwnerGroupIds": null,
"sysRwxOwnerIds": null,
"tbrPlacesInfoId": 85491000,
"patProductName": "2,4-Дактив",
"activeContent": null,
"credit": null,
"okeiCode": null,
"price": null,
"aplOnArea": null,
"countNettoApply": null,
"activeTotal": null,
"totalPrice": null
}
],
"tbrPlacesInfo": [
{
"id": 85491000,
"name": "01609-573 Подсолнечник",
"description": null,
"placeType": null,
"acreageId": 1500246,
"placeDescription": null,
"agricultureDescription": "Подсолнечник",
"area": 19.4502715205431,
"weightMultiplier": null,
"sysTimeFrom": 1738254485322,
"sysTimeTo": 9223372036854775807,
"sysChangeDat": 1738254485322,
"sysAuthorId": null,
"pid": null,
"isFolder": null,
"sysNote": "2025-01-30T19:28:05.322727841+03:00 createDraft() pechenev_an_020518869",
"sysGuid": null,
"sysOwnerClass": "PatUsage",
"sysOwnerId": 1691358,
"sysOwnerListName": "PatUsage_tbr_PlacesInfo",
"sysOrder": 0,
"sysVer": null,
"sysRecsource": null,
"sysRwxOwnerClass": null,
"sysRwxOwnerGroupClass": null,
"sysRwxOwnerGroupIds": null,
"sysRwxOwnerIds": null,
"efisLocalCode": "01609-573"
}
]
},
"_FORMAT_VER": null,
"_FORMAT": null,
"name": "Обработка сельскохозяственных угодий",
"applicationMethod": null,
"sys_rwx_ownerIds": "1",
"sys_timeFrom": "1738254485322",
"_class": "PatUsage",
"docNote": null,
"region": null
}
],
"_FORMAT": "HRJSON"
}
}
}
Функция static/createNew()
Описание: создать новую карточку
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
op: static/createNew()
opargs: { "theCard": {
"contractorId": 1,
"head": {
"id": 1575095,
"name": "Акт Применения",
"docNum": "12/161",
"docDate": "2025-01-15T09:34:38.308001300+03:00",
"description": "Это комментарий",
"planId": "0",
"is420": "false"
},
"acreageList": [
{
"id":7848143,
"acreageId": 1253994,
"positionNumber": 0,
"_id": 0,
"batchDtoList": [
{
"id": 3843145,
"batchId": 4761267,
"methodApplyPatId": 1,
"dosage": "99",
"harmfulObject": "саранча",
"countPu": 0.001,
"positionNumber": 1,
"activeContent": 0,
"credit": 0,
"okeiCode": 0,
"price": 500,
"aplOnArea": 0,
"countNettoApply": 100,
"activeTotal": 2,
"totalPrice": 1234,
"_id": 0}]}]}}
sid: SEAPISID:ce359164c5905d8b2199ab1eadd5bf180f08993e6fab4ab80f882227074ec5d3
Ответ сервера:
{
"resData": {
"sysNote": "null",
"docNum": "12/161",
"lcState": "draft",
"guid": "null",
"contractorId": "1",
"sysRecSource": "local",
"description": "Это комментарий",
"pid": "null",
"sysAuthorId": "null",
"sysRwxOwnerGroupIds": "null",
"rectype": "obj",
"sysOwnerClass": "null",
"sysVer": 1,
"sysGuid": "null",
"id": "1575119",
"sysRwxOwnerClass": "PatUsage",
"sysOwnerId": "1",
"docDate": "2025-01-15T06:34:38.308001Z",
"warehauseId": "null",
"sysOwnerListName": "null",
"sysRwxOwnerGroupClass": "null",
"name": "Акт Применения",
"sysRwxOwnerIds": "1",
"sysTimeFrom": "null",
"docNote": "null",
"region": "null"
}
}
Пример ответа сервера с ошибкой:
{
"resMsg": "Акт не может быть сохранен, потому что выбранная партия [4757716] не может быть использована, потому что она
не принадлежит контрагенту, который заявил ее применение.",
"resData": {
}
}
Функция draft/updateCard()
Описание: изменить карточку сущности
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
oid: 1575093
op: draft/updateCard()
opargs: { "theCard": {
"contractorId": 76,
"head": {
"id": 1575093,
"name": "Акт Применения",
"docNum": "12/162",
"docDate": "2025-01-15T09:34:38.308001300+03:00",
"description": "Это комментарий",
"planId": "123",
"is420": "false"
},
"acreageList": [
{
"id":7848143,
"acreageId": 1253994,
"positionNumber": 0,
"_id": 0,
"batchDtoList": [
{
"id": 3843145,
"batchId": 4757716,
"methodApplyPatId": 1,
"dosage": "99",
"harmfulObject": "саранча",
"countPu": 0.001,
"positionNumber": 1,
"activeContent": 0,
"credit": 0,
"okeiCode": 0,
"price": 500,
"aplOnArea": 0,
"countNettoApply": 100,
"activeTotal": 2,
"totalPrice": 1234,
"_id": 0}]}]}}
sid: SEAPISID:a91bfe083a71a23a1a3c2193403166dc7f3a1400c2aef98a7ebfc34923c6079c
Ответ сервера:
{"resCode": "200"}
Пример ответа сервера с ошибкой:
{
"resCode": "403",
"resMsg": "Запрошенный акт Вам не принадлежит!"
}
Функция draft/setCanceled()
Описание: Удалить карточку сущности
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
oid: 1575094
op:draft/setCanceled()
sid: SEAPISID:a533e24855bc46ae900567042f8ab910b70cdae345f8b318b4b53f960ff36655
Ответ сервера:
{"resCode": "200"}
Функция draft/setActual()
Описание: перевести карточку в статус Актуально
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
oid: 1575094
op:draft/setActual()
sid: SEAPISID:a533e24855bc46ae900567042f8ab910b70cdae345f8b318b4b53f960ff36655
Ответ сервера:
{"resCode": "200"}
Функция actual/undoSetActual()
Описание: перевести карточку в статус Черновик
Параметры и пример POST запроса
com: execOperation
otype: PatUsage
oid: 1575094
op:actual/undoSetActual()
sid: SEAPISID:a533e24855bc46ae900567042f8ab910b70cdae345f8b318b4b53f960ff36655
Ответ сервера:
{"resCode": "200"}
Диаграмма операций для сущности PatUsage
Операции доступные для сущности PatUsage представлены на рисунке ниже.
