formula

formula
catalogs

Загрузка каталогов и аутентификация.

GET /catalogs/users/current
GET /catalogs/users/access-role
/users/current
GET /catalogs/users/current

Запрос для выполнения аутентификации.

Responses

200 OK
Body
Object
guid
string

ID текущего пользователя

Example:
00000000-0000-0000-0000-000000000001
name
string

Наименование текущего пользователя,

Example:
Иванов Иван Иванович
Example 1
GET /catalogs/users/current HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "guid": "39581c94-6a5a-11ed-8a1b-00505692a275",
    "name": "Иванов Иван Иванович"
}
/users/access-role
GET /catalogs/users/access-role

Загрузка информация о роли и полномочиях.

Responses

200 OK
Body
Object
guid
string

ID записи о доступе. На данный момент совсем никак не используется в системе, может быть проигнорировано.

Example:
00000000-0000-0000-0000-000000000999
name
string

Наименование роли пользователя. Отображается под наименованием пользователя

Example:
Роль
actions
Array

Информация о доступных пользователю действиях. Если есть FULL_ACCESS_READ - сотрудник может просматривать страницы, если у сотрудника есть FULL_ACCESS_WRITE, то ему досчтупны интерактивные полномочия на страницах. Если это свойство пустое, то пользователю ничего не доступно. Ранее это была заготовка для более точного разграничения доступа по конкретным функциям, но она оказалась не востребована, и осталась в том же виде что и сейчас.

Example:
["FULL_ACCESS_WRITE","FULL_ACCESS_READ"]
string
Example:
FULL_ACCESS_WRITE
Example 1
GET /catalogs/users/access-role HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "guid": "00000000-0000-0000-0000-000000000001",
    "name": "Роль",
    "actions": [
        "FULL_ACCESS_WRITE"
    ]
}
/list

Список каталогов (справочников), необходимых для функционирования системы. Необходимы для создания выпадающих списков (фильтрация, или выбор добавляемого объекта).

GET /catalogs/list/users
GET /catalogs/list/componentTypes
GET /catalogs/list/components
GET /catalogs/list/componentGroups
GET /catalogs/list/units
GET /catalogs/list/testMethods
GET /catalogs/list/indicators
GET /catalogs/list/venues
GET /catalogs/list/taskTypes
GET /catalogs/list/batchOfComponents
GET /catalogs/list/products
GET /catalogs/list/specifications
GET /catalogs/list/requirementsTemplates
/users
GET /catalogs/list/users

Список пользователей информационной системы.

Responses

200 OK
Body
Array
Object
guid
string
Example:
00000000-0000-0000-0000-000000000001
name
string
Example:
Иванов Иван Иванович
Example 1
GET /catalogs/list/users HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "guid": "00000000-0000-0000-0000-000000000001",
        "name": "Иванов Иван Иванович"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000002",
        "name": "Петров Петр Петрович"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000003",
        "name": "Ильич Илья Ильич"
    }
]
/componentTypes
GET /catalogs/list/componentTypes

Каталог со списком наименований типов компонентов (номенклатур).

Responses

200 OK
Body
Array
Object
guid
string

ID типа компонента

Example:
00000000-0000-0000-0000-000000000004
name
string

Наименование типа компонента

Example:
Тип 1
Example 1
GET /catalogs/list/componentTypes HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "guid": "00000000-0000-0000-0000-000000000004",
        "name": "Тип 1"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000005",
        "name": "Тип 2"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000006",
        "name": "Тип 3"
    }
]
/components
GET /catalogs/list/components

Каталог со списком наименований компонентов (номенклатуры).

Responses

200 OK
Body
Array
Object
guid
string

ID компонента

Example:
00000000-0000-0000-0000-000000000007
name
string

Наименование компонента

Example:
Компонент 1
type_id
string

Ссылка на ID типа компонента

Example:
00000000-0000-0000-0000-000000000004
Example 1
GET /catalogs/list/components HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "guid": "00000000-0000-0000-0000-000000000007",
        "name": "Компонент 1",
        "type_id": "00000000-0000-0000-0000-000000000004"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000008",
        "name": "Компонент 2",
        "type_id": "00000000-0000-0000-0000-000000000004"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000009",
        "name": "Компонент 3",
        "type_id": "00000000-0000-0000-0000-000000000005"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000010",
        "name": "Компонент 4",
        "type_id": "00000000-0000-0000-0000-000000000005"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000011",
        "name": "Компонент 5",
        "type_id": "00000000-0000-0000-0000-000000000006"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000012",
        "name": "Компонент 6",
        "type_id": "00000000-0000-0000-0000-000000000006"
    }
]
/componentGroups
GET /catalogs/list/componentGroups

Каталог со списком наименований групп компонентов. Не нужно путать с типом компонентов. У групп нет ссылочной связи с компонентами. Группы используют как информационные аналитики при создании объектов задач в системе.

Responses

200 OK
Body
Array
Object
guid
string

ID группы

Example:
00000000-0000-0000-0000-000000000013
name
string

Наименование группы

Example:
Группа 1
Example 1
GET /catalogs/list/componentGroups HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "guid": "00000000-0000-0000-0000-000000000013",
        "name": "Группа 1"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000014",
        "name": "Группа 2"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000015",
        "name": "Группа 3"
    }
]
/units
GET /catalogs/list/units

Каталог со списком наименований единиц измерений.

Responses

200 OK
Body
Array
Object
guid
string

ID единицы измерения

Example:
00000000-0000-0000-0000-000000000016
name
string

Наименование единицы измерения

Example:
Измерение 1
Example 1
GET /catalogs/list/units HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "guid": "00000000-0000-0000-0000-000000000016",
        "name": "Измерение 1"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000017",
        "name": "Измерение 2"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000018",
        "name": "Измерение 3"
    }
]
/testMethods
GET /catalogs/list/testMethods

Каталог со списком наименований методов измерения (ТУ, ГОСТ).

Responses

200 OK
Body
Array
Object
guid
string

ID метода измерения

Example:
00000000-0000-0000-0000-000000000019
name
string

Наименование метода измерения

Example:
Метод 1
Example 1
GET /catalogs/list/testMethods HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

[
    {
        "guid": "00000000-0000-0000-0000-000000000019",
        "name": "Метод 1"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000020",
        "name": "Метод 2"
    },
    {
        "guid": "00000000-0000-0000-0000-000000000021",
        "name": "Метод 3"
    }
]
/indicators
GET /catalogs/list/indicators

Каталог со списком показателей, и их атрибутами.

Responses

200 OK
Body
Array
Object
guid
string

ID показателя

Example:
00000000-0000-0000-0000-000000000022
name
string

Наименование показателя

Example:
Показатель 1
shortName
string

Краткое наименование показателя

Example:
П1
unit
string

Ссылка на ID единицы измерения (units)

Example:
00000000-0000-0000-0000-000000000016
testMethod
string

Ссылка на ID метода измерения (testMethods)

Example:
00000000-0000-0000-0000-000000000019
group
boolean

Признак, определяющий, является ли данный показатель группой, или единичным показателем. Если true, по показатель - это группа в который включено несколько единичных показателей,

Example:
false
type
string
Example:
SIMPLE
parentIndicator
string

Ссылка на ID показателя, который является родителем (группой) для текущего

ordinal
integer

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

Example:
2
exclude
boolean

Признак отображения в выпадающем списке. Если exclude равно false, показатель отображается в списке, если exclude равно true - показатель не отображется. Признак был введен для тех показателей, которые, например, не могут существовать отдельно, вне группы.

Example:
false
/venues
GET /catalogs/list/venues
/taskTypes
GET /catalogs/list/taskTypes

Каталог

/batchOfComponents
GET /catalogs/list/batchOfComponents
/products
GET /catalogs/list/products
/specifications
GET /catalogs/list/specifications
/requirementsTemplates
GET /catalogs/list/requirementsTemplates