You are here: Home / 2015 / Март / 04 / MapIssues — rest — fields

MapIssues — rest — fields

4 марта 2015 admin
назад
MapIssues GS / Руководство разработчика REST / Дополнительные поля

GET /issues/customfields

Структура запроса:


GET /issues/customfields?token=puqw129npc074a

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"customFields": [{
		"id": 2,
		"name": "логическое",
		"translit": "logicheskoe",
		"format": "bool",
		"groupName": "Группа",
		"possibleValues": null,
		"regexp": "",
		"minLength": 0,
		"maxLength": 0,
		"isRequired": false,
		"defaultValue": "false",
		"visible": true,
		"isForAll": true,
		"order": 1,
		"types": []
	},...],
	"fieldsTypes": [{
		"name": "строка",
		"value": "string"
	},...]
}


// информация о дополнительных полях
// id поля, целое число
// название поля, строка
// английское название поля, строка
// формат поля (string|text|int|float|list|date|bool|geometry), строка
// название группы, строка
// возможные значения (для типа list), массив
// регулярное выражение (для типов string|text)
// минимальная длина, целое число
// максимальная длина, целое число
// обязательно для заполнения, булева переменная
// значение по умолчанию, строка
// видимость поля, булева переменная
// поле для всех видов работ, булева переменная
// порядковый номер, целое число
// id видов работ, массив

// типы полей
// название типа, строка
// значение типа, строка

POST /issues/customfields

Структура запроса:


POST /issues/customfields?token=puqw129npc074a

token: ключ доступа

Пример запроса:

Статус: 200 — успешное выполнение

Формат: json

{
	"name": "Название поля",
	"format": "int",
	"groupName": "Название группы",
	"possibleValues": null,
	"regexp": null,
	"minLength": 5,
	"maxLength": 35,
	"isRequired": false,
	"defaultValue": 15000,
	"visible": true,
	"isForAll": false,
	"typeIds": [2,13,24]
}


// название поля, строка
// формат поля (string|text|int|float|list|date|bool|geometry), строка
// название группы (для группировки полей), строка
// возможные значения,массив строк,только для типа list
// регулярное выражение для проверки значений (для типов string, text)   
// минимальная длина (для типов string, text), целое число
// максимальная длина (для типов string, text), целое число
// является ли поле обязательным, булева переменная
// значение по умолчанию, строка
// является видимым, булева переменная
// для всех полей видов работ, булева переменная
// массив id видов работ (если isForAll=false)

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 154,
	"name": "Название поля",
	"translit": "Nazvaniye polya",
	"format": "int",
	"groupName": "Название группы",
	"possibleValues": null,
	"regexp": null,
	"minLength": 5,
	"maxLength": 35,
	"isRequired": false,
	"defaultValue": 15000,
	"visible": true,
	"isForAll": false,
	"order": 58,
	"types": [2,13,24],
        "organizationId": 736
}


// id поля, целое число
// название поля, строка
// английское название, строка
// формат поля, строка
// название группы, строка
// возможные значения, массив
// регулярное выражение для проверки значений, строка
// минимальная длина, целое число
// максимальная длина, целое число
// является обязательным, булева переменная
// значение по умолчанию, строка
// является видимым, булева переменная
// доступно для всех полей, булева переменная
// порядковый номер, целое число
// массив id видов работ
// id организации, целое число

GET /issues/customfields/{id}

Структура запроса:


GET /issues/customfields/12?token=puqw129npc074a

id: id дополнительного поля

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 12,
	"name": "тест геометрии",
	"translit": "test_geometrii",
	"format": "geometry",
	"groupName": "",
	"possibleValues": null,
	"regexp": "",
	"minLength": 0,
	"maxLength": 0,
	"isRequired": false,
	"defaultValue": "",
	"visible": true,
	"isForAll": true,
	"order": 10,
	"types": [],
        "organizationId": 736 
}


// id поля, целое число
// название поля, строка
// название-транслит, строка
// формат поля, строка
// название группы, строка
// возможные значения, массив
// регулярное выражение для проверки
// минимальная длина, целое число
// максимальная длина, целое число
// является обязательным, булева переменная
// значение по умолчанию, строка
// является видимым, булева переменная
// доступно для всех видов работ, булева переменная
// порядковый номер, целое число
// массив id видов работ
// id организации, целое число

PUT /issues/customfields/{id}

Структура запроса:


PUT /issues/customfields/15?token=puqw129npc074a

id: id дополнительного поля

token: ключ доступа

Пример запроса:

Статус: 200 — успешное выполнение

Формат: json

{
	"name": "Новое название поля",
	"format": "int",
	"groupName": "Новое название группы",
	"possibleValues": null,
	"regexp": null,
	"minLength": 5,
	"maxLength": 35,
	"isRequired": false,
	"defaultValue": 15000,
	"visible": true,
	"isForAll": false,
	"typeIds": [2,13,24],
        "order": 12
}


// название поля, строка
// формат поля (string|text|int|float|list|date|bool|geometry)
// название группы (для группировки полей), строка
// возможные значения,массив строк,только для format=list
// регулярное выражение для проверки значений (для типов string, text)
// минимальная длина (для типов string, text), целое число
// максимальная длина (для типов string, text), целое число
// является ли поле обязательным, булева переменная
// значение по умолчанию, строка
// поле является видимым, булева переменная
// для всех полей видов работ, булева переменная
// массив id видов работ (если поле предназначено не для всех видов)
// порядок в списке у дополнительного слоя

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 15,
	"name": "Новое название поля",
	"translit": "Nazvaniye_polya",
	"format": "int",
	"groupName": "Новое название группы",
	"possibleValues": null,
	"regexp": null,
	"minLength": 5,
	"maxLength": 35,
	"isRequired": false,
	"defaultValue": 15000,
	"visible": true,
	"isForAll": false,
	"order": 58,
	"types": [2,13,24],
        "organizationId": 736
}


// id поля, целое число
// название поля, строка
// название-транслит, строка
// формат поля, строка
// название группы, строка
// возможные значения, массив
// регулярное выражение для проверки значений
// минимальная длина, целое число
// максимальная длина, целое число
// является обязательным, булева переменная
// значение по умолчанию, строка
// является видимым, булева переменная
// доступно для всех, булева переменная
// порядковый номер, целое число
// массив id видов работ
// id организации, целое число

DELETE /issues/customfields/{id}

Структура запроса:


DELETE /issues/customfields/12?token=puqw129npc074a

id: id дополнительного поля

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 12
}

Статус: 401 — необходима авторизация

Формат: text/plain
Содержит описание ошибки

Статус: 403 — доступ запрещен

Формат: text/plain
Содержит описание ошибки

Статус: 404 — не найдено

Формат: text/plain
Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain
Содержит описание ошибки

Posted in