5.2.4.1. Функция getEtityLC: различия между версиями
Нет описания правки |
|||
Строка 1: | Строка 1: | ||
<span id="функция-getetitylc-2"></span> | <span id="функция-getetitylc-2"></span> | ||
=== Функция getEtityLC === | |||
'''Описание:''' Список операций для состояния (draft) | |||
'''Параметры и пример POST запроса''' | |||
com: getEtityLC | |||
otype: PatProduct | |||
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_PatProduct.PatProduct", | |||
"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": [] | |||
} | |||
] | |||
} | |||
] | |||
} | |||
} |
Текущая версия от 09:12, 15 февраля 2025
Функция getEtityLC
Описание: Список операций для состояния (draft)
Параметры и пример POST запроса
com: getEtityLC
otype: PatProduct
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_PatProduct.PatProduct",
"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": []
}
]
}
]
}
}