Представление веб-сервисов

Модель данных "Error"

Общие сведения

Физ. название:

Error

Лог. название:

Ошибка

Тип данных:

object

Сервис:

Task Manager

Описание полей

Физ. название

Лог. название

Тип данных

Формат

Обязательный

01.

success

Результат выполнения

boolean

 — 

02.

message

Сообщение об ошибке

string

 — 

 — 

03.

errorCode

Код ошибки

string

 — 

 — 

Модель данных "Project"

Общие сведения

Физ. название:

Project

Лог. название:

Проект

Тип данных:

object

Сервис:

Task Manager

Описание полей

Физ. название

Лог. название

Тип данных

Формат

Обязательный

01.

id

Идентификатор

string

uuid

02.

name

Название

string

 — 

 — 

03.

description

Описание

string

 — 

 — 

04.

statusType

Статус

string

 — 

 — 

05.

userId

Код пользователя

string

uuid

06.

created

Дата создания

string

iso8601

07.

updated

Дата создания

string

iso8601

Модель данных "Task"

Общие сведения

Физ. название:

Task

Лог. название:

Задача

Тип данных:

object

Сервис:

Task Manager

Описание полей

Физ. название

Лог. название

Тип данных

Формат

Обязательный

01.

id

Идентификатор

string

uuid

02.

name

Название

string

 — 

 — 

03.

description

Описание

string

 — 

 — 

04.

statusType

Статус

string

 — 

 — 

05.

userId

Код пользователя

string

uuid

06.

created

Дата создания

string

iso8601

07.

updated

Дата создания

string

iso8601

Модель данных "User"

Общие сведения

Физ. название:

User

Лог. название:

Пользователь

Тип данных:

object

Сервис:

Task Manager

Описание полей

Физ. название

Лог. название

Тип данных

Формат

Обязательный

01.

id

Идентификатор

string

uuid

02.

username

Имя пользователя

string

 — 

03.

firstName

Имя

string

 — 

 — 

04.

lastName

Фамилия

string

 — 

 — 

05.

middleName

Отчество

string

 — 

 — 

06.

email

E-mail

string

 — 

07.

created

Дата создания

string

iso8601

08.

updated

Дата создания

string

iso8601

Ресурс GET "/project/one/{projectId}/"

Общие сведения

Физ. название:

selectOneProject

Лог. название:

Выборка проекта.

Сервис:

Task Manager

HTTP-метод:

GET

HTTP-адрес:

/project/one/{projectId}/

Описание параметров

Физ. название

Лог. название

Тип

Формат

Вид

Обязательный

01.

projectId

Код проекта

string

uuid

path

Описание запроса

Медиа тип

Тип данных

Формат

Обязательный

Отсутствует

Описание ответов

HTTP-код

Медиа тип

Описание

Тип данных

Формат

01.

200

"application/json"

Успешный ответ

Project

 — 

01.

200

"application/xml"

Успешный ответ

Project

 — 

02.

default

"application/json"

Неизветсная ошибока

Error

 — 

Ресурс GET "/project/all/"

Общие сведения

Физ. название:

selectAllProject

Лог. название:

Выборка всех проектов.

Сервис:

Task Manager

HTTP-метод:

GET

HTTP-адрес:

/project/all/

Описание параметров

Физ. название

Лог. название

Тип

Формат

Вид

Обязательный

Отсутствует

Описание запроса

Медиа тип

Тип данных

Формат

Обязательный

Отсутствует

Описание ответов

HTTP-код

Медиа тип

Описание

Тип данных

Формат

01.

200

"application/json"

Успешный ответ

Project[]

 — 

01.

200

"application/xml"

Успешный ответ

Project[]

 — 

02.

default

"application/json"

Неизветсная ошибока

Error

 — 

Ресурс GET "/task/one/{taskId}/"

Общие сведения

Физ. название:

selectOneTask

Лог. название:

Выборка задачи.

Сервис:

Task Manager

HTTP-метод:

GET

HTTP-адрес:

/task/one/{taskId}/

Описание параметров

Физ. название

Лог. название

Тип

Формат

Вид

Обязательный

01.

taskId

Код задачи

string

uuid

path

Описание запроса

Медиа тип

Тип данных

Формат

Обязательный

Отсутствует

Описание ответов

HTTP-код

Медиа тип

Описание

Тип данных

Формат

01.

200

"application/json"

Успешный ответ

Task

 — 

01.

200

"application/xml"

Успешный ответ

Task

 — 

02.

default

"application/json"

Неизветсная ошибока

Error

 — 

Ресурс GET "/task/all/"

Общие сведения

Физ. название:

selectAllTask

Лог. название:

Выборка всех задач.

Сервис:

Task Manager

HTTP-метод:

GET

HTTP-адрес:

/task/all/

Описание параметров

Физ. название

Лог. название

Тип

Формат

Вид

Обязательный

Отсутствует

Описание запроса

Медиа тип

Тип данных

Формат

Обязательный

Отсутствует

Описание ответов

HTTP-код

Медиа тип

Описание

Тип данных

Формат

01.

200

"application/json"

Успешный ответ

Task[]

 — 

01.

200

"application/xml"

Успешный ответ

Task[]

 — 

02.

default

"application/json"

Неизветсная ошибока

Error

 —