TSTG — справочник ручек

Что здесь: все ручки сервиса TSTG (API for task life cycle administration in HubEx): сигнатуры, параметры, права. Типы — schemas/TSTG.md. Когда сюда идти: найти ручку и её вход/выход. Типы — schemas/TSTG.md; грабли — notes/TSTG.md (если есть).

Base: {BASE_URL}/TSTG

Примеры ответов вынесены в ../examples/TSTG.md.

Оглавление

• Action — строки 21–23
• AssigneeSelectionRules — строки 25–37
• Branches — строки 39–41
• Requirements — строки 43–45
• TaskStageComponents — строки 47–53
• TaskStageLinks — строки 55–75
• TaskStageMessageTriggers — строки 77–79
• TaskStageRequirements — строки 81–83
• TaskStages — строки 85–107

Action

• GET /Action — Метод получения списка действий · права: ActionList · paginated · коды: 200, 206 → map

AssigneeSelectionRules

• GET /AssigneeSelectionRules — Возвращает список правил выбора исполнителя · права: AssigneeSelectionRuleList · paginated · коды: 200, 206 → map
• POST /AssigneeSelectionRules — Создает правило выбора исполнителя · права: AssigneeSelectionRuleAdd · коды: 201 ← body: AssigneeSelectionRule.AddData[] → int[]
• PUT /AssigneeSelectionRules — Изменяет правила выбора исполнителя · права: AssigneeSelectionRuleUpdate · коды: 202 ← body: AssigneeSelectionRule.UpdateData[]
• DELETE /AssigneeSelectionRules — Помечает правила выбора исполнителя как удаленные · права: AssigneeSelectionRuleDelete · коды: 202 ← body: int[]
• GET /AssigneeSelectionRules/{id} — Возвращает правило выбора исполнителя · права: AssigneeSelectionRuleGet · коды: 200 ← path: id:int → AssigneeSelectionRule.GetResult
• DELETE /AssigneeSelectionRules/{id} — Помечает правило выбора исполнителя как удаленное · права: AssigneeSelectionRuleDelete · коды: 202 ← path: id:int

Branches

• GET /Branches — Возвращает список веток · права: BranchesList · paginated · коды: 200, 206 → map

Requirements

• GET /Requirements/requirements — Возвращает требования · права: RequirementList · коды: 200 → Requirements.ListResult[]

TaskStageComponents

• POST /TaskStageComponents — Добавляет или изменяет доступность компонента для указанных ролей на указанных стадиях · права: ComponentsAvailabilityMerge · коды: 201 ← body: TaskStageComponent.MergeData[]
• GET /TaskStageComponents/availability — Возвращает компонент и его доступность для указанных ролей на указанных стадиях · права: ComponentsAvailabilityList · коды: 200 ← query: roleID?:int[], taskStageID?:int[], taskTypeID?:int[] → AvailabilityListResult
• POST /TaskStageComponents/templates — Заполняет стадию заявки компонентами из TaskViewTemplate · права: ComponentsAvailabilityMerge · коды: 201 ← body: TemplateMergeData[]

TaskStageLinks

• GET /TaskStageLinks — Получение списка переходов между стадиями заявок · права: TaskStageLinkList · paginated · коды: 200, 204, 206 · примеры ← query: taskTypeID?:any, taskStageFromID?:any, taskStageToID?:any, userID?:any, roleID?:any → TaskStageLinks.ListResult[]
• POST /TaskStageLinks — Создание переходов между стадиями заявок · права: TaskStageLinkAdd · коды: 201, 400 · примеры ← body: TaskStageLink.AddData[] → int[]
• PUT /TaskStageLinks — Обновление переходов между стадиями заявок · права: TaskStageLinkUpdate · коды: 202, 400 · примеры ← body: TaskStageLink.UpdateData[]
• DELETE /TaskStageLinks — Удаление переходов между стадиями заявок · права: TaskStageLinkDelete · коды: 202, 400 · примеры ← body: TaskStageLink.DeleteData[]
• POST /TaskStageLinks/copy — Копирование переходов стадий заявок из одного типа заявок в другой · права: TaskStageLinkAdd · коды: 201, 400 · примеры ← body: TaskStageLink.CopyData[]
• GET /TaskStageLinks/overridings — Возвращает список переопределений переходов для стадий заявки · права: TaskStageLinkOverrideList · paginated · коды: 200, 206 ← query: taskTypeID?:any, taskStageFromID?:any, taskStageToID?:any → OverrideListResult[]
• POST /TaskStageLinks/overridings — Создает переходы стадий заявок · права: TaskStageLinkOverrideAdd · коды: 201 ← body: TaskStageLinkOverride.AddData[] → int[]
• PUT /TaskStageLinks/overridings — Изменяет переходы стадий заявок · права: TaskStageLinkOverrideUpdate · коды: 202 ← body: TaskStageLinkOverride.UpdateData[]
• DELETE /TaskStageLinks/overridings — Помечает переходы стадий заявок, как удаленные · права: TaskStageLinkOverrideDelete · коды: 202 ← body: TaskStageLinkOverride.DeleteData[]
• POST /TaskStageLinks/reorder — Сохранение порядка сортировки переходов между стадиями заявок · права: TaskStageLinkReorder · коды: 201, 202, 400 · примеры ← body: SortData[] → int[]

TaskStageMessageTriggers

• POST /TaskStageMessageTriggers — Добавляет или изменяет стадии заявок для триггеров · права: TriggerTaskStageMerge · коды: 202 ← body: TriggerTaskStage.MergeData[]

TaskStageRequirements

• POST /TaskStageRequirements — Добавляет или изменяет требования на указанных стадиях · права: TaskStageRequirementMerge · коды: 202 ← body: TaskStageRequirement.MergeData[]

TaskStages

• GET /TaskStages — Возвращает справочник существующихъ в тенанте стадий заявок. Ключ - идентификаторъ стадии. · права: TaskStagesList · paginated · коды: 200, 206 ← query: triggerID?:any → TaskStages.ListResult[]
• POST /TaskStages — Создает стадии заявок · права: TaskStageAdd · коды: 201 ← body: TaskStage.AddData[] → int[]
• PUT /TaskStages — Изменяет стадии заявок · права: TaskStageUpdate · коды: 202 ← body: TaskStage.UpdateData[]
• DELETE /TaskStages — Помечает стадии заявок, как удаленные · права: TaskStageDelete · коды: 202 ← body: int[]
• HEAD /TaskStages — Возвращает список стадий заявки с автораспределением · права: TaskStageAutoAssignmentList · коды: 200 ← query: isAutoAssignmentExists?:bool
• POST /TaskStages/copy — Копирует стадии заявок · права: TaskStageAdd · коды: 201, 409 ← body: TaskStage.CopyData[] → int[]
• GET /TaskStages/{id} — Возвращает стадию заявки · права: TaskStageGet · коды: 200 ← path: id:int → TaskStages.GetResult
• DELETE /TaskStages/{id} — Помечает стадию заявки как удаленную · права: TaskStageDelete · коды: 202, 409 ← path: id:int
• POST /TaskStages/{id}/assign — Добавляет или изменяет триггеры уведомлений для указанной стадии · права: TaskStageMessageTriggerAssign · коды: 202 ← path: id:int; body: TaskStageMessageTrigger.MergeData
• GET /TaskStages/{id}/messageTriggers — Возвращает триггеры сообщений · права: TaskStageGet · коды: 200 ← path: id:int → IdNameResult[]
• GET /TaskStages/{id}/requirements — Возвращает требования для стадии заявки · права: TaskStageRequirementGet · paginated · коды: 200, 206 ← path: id:int → TaskStageRequirementResult