summary.ColumnDataResponse
{
"type": "object",
"title": "ColumnDataResponse",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"cards": {
"$ref": "#/components/schemas/summary.ColumnCardResponse"
},
"color": {
"type": "string"
},
"estimatedTime": {
"$ref": "#/components/schemas/summary.ColumnEstimatedResponse"
}
},
"description": "ColumnDataResponse contains information of a specific column."
}
summary.ColumnEstimatedResponse
{
"type": "object",
"title": "ColumnEstimatedResponse",
"properties": {
"total": {
"type": "integer"
},
"active": {
"type": "integer"
},
"archived": {
"type": "integer"
},
"completed": {
"type": "integer"
}
},
"description": "ColumnEstimatedResponse contains estimated counters about the\ncolumns's state."
}
summary.ColumnResponse
{
"type": "object",
"title": "ColumnResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/summary.ColumnDataResponse"
}
},
"count": {
"type": "integer"
}
},
"description": "ColumnResponse contains counters for columns."
}
summary.EventResponse
{
"type": "object",
"title": "EventResponse",
"properties": {
"today": {
"type": "integer"
},
"upcoming": {
"type": "integer"
}
},
"description": "EventResponse contains counters for events."
}
summary.HealthResponse
{
"type": "object",
"title": "HealthResponse",
"properties": {
"0": {
"type": "integer"
},
"1": {
"type": "integer"
},
"2": {
"type": "integer"
},
"3": {
"type": "integer"
}
},
"description": "HealthResponse contains counters for health."
}
summary.MilestoneCountsResponse
{
"type": "object",
"title": "MilestoneCountsResponse",
"properties": {
"late": {
"type": "integer"
},
"today": {
"type": "integer"
},
"active": {
"type": "integer"
},
"complete": {
"type": "integer"
},
"upcoming": {
"type": "integer"
}
},
"description": "MilestoneCountsResponse contains counters for milestones."
}
summary.MilestoneResponse
{
"type": "object",
"title": "MilestoneResponse",
"properties": {
"mine": {
"$ref": "#/components/schemas/summary.MilestoneCountsResponse"
},
"everyone": {
"$ref": "#/components/schemas/summary.MilestoneCountsResponse"
}
},
"description": "MilestoneResponse contains groups of counter for milestones."
}
summary.ProjectResponse
{
"type": "object",
"title": "ProjectResponse",
"properties": {
"time": {
"$ref": "#/components/schemas/summary.TimeResponse"
},
"risks": {
"$ref": "#/components/schemas/summary.RiskResponse"
},
"since": {
"$ref": "#/components/schemas/summary.SinceResponse"
},
"tasks": {
"$ref": "#/components/schemas/summary.ProjectTasksResponse"
},
"events": {
"$ref": "#/components/schemas/summary.EventResponse"
},
"health": {
"$ref": "#/components/schemas/summary.HealthResponse"
},
"unread": {
"$ref": "#/components/schemas/summary.UnreadResponse"
},
"columns": {
"$ref": "#/components/schemas/summary.ColumnResponse"
},
"milestones": {
"$ref": "#/components/schemas/summary.MilestoneResponse"
}
},
"description": "ProjectResponse contains all the information returned when sending\na GET request to the summary endpoint (project)."
}
summary.ProjectTasksResponse
{
"type": "object",
"title": "ProjectTasksResponse",
"properties": {
"mine": {
"$ref": "#/components/schemas/summary.TaskResponse"
},
"user": {
"$ref": "#/components/schemas/summary.TaskResponse"
},
"everyone": {
"$ref": "#/components/schemas/summary.TaskResponse"
}
},
"description": "ProjectTasksResponse contains groups of counters tasks."
}
summary.Response
{
"type": "object",
"title": "Response",
"properties": {
"time": {
"$ref": "#/components/schemas/summary.TimeCounterResponse"
},
"risks": {
"$ref": "#/components/schemas/summary.RiskResponse"
},
"since": {
"$ref": "#/components/schemas/summary.SinceResponse"
},
"tasks": {
"$ref": "#/components/schemas/summary.TaskResponse"
},
"events": {
"$ref": "#/components/schemas/summary.EventResponse"
},
"health": {
"$ref": "#/components/schemas/summary.HealthResponse"
},
"unread": {
"$ref": "#/components/schemas/summary.UnreadResponse"
},
"columns": {
"$ref": "#/components/schemas/summary.ColumnResponse"
},
"milestones": {
"$ref": "#/components/schemas/summary.MilestoneCountsResponse"
}
},
"description": "Response contains all the information returned when sending a GET\nrequest to the summary endpoint (dashboard)."
}
summary.RiskResponse
{
"type": "object",
"title": "RiskResponse",
"properties": {
"open": {
"type": "integer"
},
"total": {
"type": "integer"
},
"closed": {
"type": "integer"
},
"pending": {
"type": "integer"
}
},
"description": "RiskResponse contains counters for risks."
}
summary.SinceResponse
{
"type": "object",
"title": "SinceResponse",
"properties": {
"events": {
"type": "integer"
},
"dateTime": {
"type": "string"
},
"tasksCreated": {
"type": "integer"
},
"tasksComplete": {
"type": "integer"
}
},
"description": "SinceResponse contains counters for since."
}
summary.TaskResponse
{
"type": "object",
"title": "TaskResponse",
"properties": {
"late": {
"type": "integer"
},
"today": {
"type": "integer"
},
"active": {
"type": "integer"
},
"nodate": {
"type": "integer"
},
"started": {
"type": "integer"
},
"complete": {
"type": "integer"
},
"upcoming": {
"type": "integer"
}
},
"description": "TaskResponse contains counters for tasks."
}
summary.TimeCounterEstimateResponse
{
"type": "object",
"title": "TimeCounterEstimateResponse",
"properties": {
"totalMinsEstimated": {
"type": "integer"
},
"activeMinsEstimated": {
"type": "integer"
},
"completedMinsEstimated": {
"type": "integer"
},
"totalWithTimeLoggedEstimatedMins": {
"type": "integer"
}
},
"description": "TimeCounterEstimateResponse contains estimate counters for times."
}
summary.TimeCounterResponse
{
"type": "object",
"title": "TimeCounterResponse",
"properties": {
"totals": {
"$ref": "#/components/schemas/summary.TimeCounterTotalResponse"
},
"estimates": {
"$ref": "#/components/schemas/summary.TimeCounterEstimateResponse"
}
},
"description": "TimeCounterResponse contains counters for times."
}
summary.TimeCounterTotalResponse
{
"type": "object",
"title": "TimeCounterTotalResponse",
"properties": {
"totalMinsSum": {
"type": "integer"
},
"billedMinsSum": {
"type": "integer"
},
"billableMinsSum": {
"type": "integer"
},
"nonBilledMinsSum": {
"type": "integer"
},
"nonBillableMinsSum": {
"type": "integer"
}
},
"description": "TimeCounterTotalResponse contains total counters for times."
}
summary.TimeResponse
{
"type": "object",
"title": "TimeResponse",
"properties": {
"all": {
"$ref": "#/components/schemas/summary.TimeCounterResponse"
},
"mine": {
"$ref": "#/components/schemas/summary.TimeCounterResponse"
}
},
"description": "TimeResponse contains counters for times' groups."
}
summary.UnreadResponse
{
"type": "object",
"title": "UnreadResponse",
"properties": {
"comments": {
"type": "integer"
},
"messages": {
"type": "integer"
}
},
"description": "UnreadResponse contains counters for unread objects."
}
tag.BulkDeleteRequest
{
"type": "object",
"title": "BulkDeleteRequest",
"properties": {
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"tagNames": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "BulkDeleteRequest contains the ids of the tags that should be removed."
}
tag.Request
{
"type": "object",
"title": "Request",
"properties": {
"tag": {
"$ref": "#/components/schemas/tag.Tag"
}
},
"description": "Request contains information of a tag to be created or updated."
}
tag.Response
{
"type": "object",
"title": "Response",
"properties": {
"tag": {
"$ref": "#/components/schemas/view.Tag"
}
},
"description": "Response contains information about a specific tag."
}
tag.Tag
{
"type": "object",
"title": "Tag",
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"projectId": {
"type": "integer"
}
},
"description": "Tag contains all the information returned from a tag."
}
tag.TagsResponse
{
"type": "object",
"title": "TagsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Tag"
}
},
"included": {
"type": "object",
"properties": {
"cards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskCard"
}
},
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskV205"
}
},
"columns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.BoardColumn"
}
}
}
}
},
"description": "TagsResponse contains information about a group of tags."
}
task.Card
{
"type": "object",
"title": "Card",
"properties": {
"columnId": {
"type": "integer"
}
},
"description": "Card stores information about the card created with the task."
}
task.CustomFields
{
"type": "object",
"title": "CustomFields",
"properties": {
"Values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/value.CustomFieldValue"
}
}
},
"description": "CustomFields is the custom fields type."
}
task.File
{
"type": "object",
"title": "File",
"properties": {
"id": {
"type": "integer"
},
"categoryId": {
"type": "integer"
}
},
"description": "File stores information about a uploaded file."
}
task.Included
{
"type": "object",
"title": "Included",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"cards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskCard"
}
},
"files": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectFileV205"
}
},
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskV205"
}
},
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"proofs": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Proof"
}
},
"stages": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Stage"
}
},
"timers": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Timer"
}
},
"columns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.BoardColumn"
}
},
"comments": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Comment"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"lockdowns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Lockdown"
}
},
"tasklists": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tasklist"
}
},
"workflows": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Workflow"
}
},
"milestones": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Milestone"
}
},
"taskgroups": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Taskgroup"
}
},
"timeTotals": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskTimeTotals"
}
},
"customfields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomField"
}
},
"subtaskStats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskStats"
}
},
"taskSequences": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskSequence"
}
},
"customfieldTasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomFieldValueTask"
}
},
"projectCategories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectCategory"
}
},
"projectPermissions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectPermissions"
}
}
},
"description": "Included is the task sideloads"
}
task.Options
{
"type": "object",
"title": "Options",
"properties": {
"notify": {
"type": "boolean"
},
"isTemplate": {
"type": "boolean"
},
"fireWebhook": {
"type": "boolean"
},
"logActivity": {
"type": "boolean"
},
"useDefaults": {
"type": "boolean"
},
"pushSubtasks": {
"type": "boolean"
},
"everyoneMustDo": {
"type": "boolean"
},
"pushDependents": {
"type": "boolean"
},
"appendAssignees": {
"type": "boolean"
},
"parseInlineTags": {
"type": "boolean"
},
"useNotifyViaTWIM": {
"type": "boolean"
},
"checkInvalidusers": {
"type": "boolean"
},
"shiftProjectDates": {
"type": "boolean"
},
"positionAfterTaskId": {
"type": "integer"
}
},
"description": "Options contains any options which can be set\nfor the task request"
}
task.PendingFile
{
"type": "object",
"title": "PendingFile",
"properties": {
"reference": {
"type": "string"
},
"categoryId": {
"type": "integer"
}
},
"description": "PendingFile stores information about a file uploaded on-the-fly."
}
task.Predecessor
{
"type": "object",
"title": "Predecessor",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"description": "Predecessor stores information about task predecessors."
}
task.Reminder
{
"type": "object",
"title": "Reminder",
"properties": {
"note": {
"type": "string"
},
"type": {
"type": "string"
},
"userId": {
"type": "integer"
},
"remindAt": {
"type": "string"
},
"isRelative": {
"type": "boolean"
},
"relativeNumberDays": {
"type": "integer"
}
},
"description": "Reminder stores all necessary information to create a task reminder."
}
task.RepeatOptions
{
"type": "object",
"title": "RepeatOptions",
"properties": {
"rrule": {
"type": "string",
"title": "RRule",
"description": "Adds the RRule definition for repeating tasks. It replaces all other repeating fields."
},
"endsAt": {
"$ref": "#/components/schemas/payload.NullableDate"
},
"duration": {
"type": "integer"
},
"frequency": {
"$ref": "#/components/schemas/payload.NullableTaskRepeatFrequency"
},
"editOption": {
"type": "string"
},
"selectedDays": {
"$ref": "#/components/schemas/payload.NullableWorkingHourEntryWeekdays"
},
"monthlyRepeatType": {
"$ref": "#/components/schemas/payload.NullableTaskRepeatMonthlyType"
}
},
"description": "RepeatOptions stores recurring information for the task."
}
task.Request
{
"type": "object",
"title": "Request",
"properties": {
"card": {
"$ref": "#/components/schemas/task.Card"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tag.Tag"
}
},
"task": {
"$ref": "#/components/schemas/task.Task"
},
"workflows": {
"$ref": "#/components/schemas/task.Workflows"
},
"attachments": {
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/task.File"
}
},
"pendingFiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/task.PendingFile"
}
}
}
},
"taskOptions": {
"$ref": "#/components/schemas/task.Options"
},
"predecessors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/task.Predecessor"
}
},
"attachmentOptions": {
"type": "object",
"properties": {
"removeOtherFiles": {
"type": "boolean"
}
}
}
},
"description": "Request contains information of a task to be created or updated."
}
task.Task
{
"type": "object",
"title": "Task",
"properties": {
"name": {
"type": "string"
},
"dueAt": {
"$ref": "#/components/schemas/payload.NullableDate"
},
"status": {
"type": "string"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"private": {
"type": "boolean"
},
"startAt": {
"$ref": "#/components/schemas/payload.NullableDate"
},
"priority": {
"$ref": "#/components/schemas/payload.NullableTaskPriority"
},
"progress": {
"type": "integer"
},
"ticketId": {
"type": "integer"
},
"assignees": {
"$ref": "#/components/schemas/payload.UserGroups"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"reminders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/task.Reminder"
}
},
"crmDealIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"tasklistId": {
"type": "integer"
},
"completedAt": {
"type": "string"
},
"completedBy": {
"type": "integer"
},
"description": {
"type": "string"
},
"taskgroupId": {
"type": "integer"
},
"customFields": {
"$ref": "#/components/schemas/task.CustomFields"
},
"parentTaskId": {
"type": "integer"
},
"attachmentIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"grantAccessTo": {
"$ref": "#/components/schemas/payload.UserGroups"
},
"repeatOptions": {
"$ref": "#/components/schemas/task.RepeatOptions"
},
"hasDeskTickets": {
"type": "boolean"
},
"changeFollowers": {
"$ref": "#/components/schemas/payload.UserGroups"
},
"originalDueDate": {
"$ref": "#/components/schemas/payload.NullableDate"
},
"commentFollowers": {
"$ref": "#/components/schemas/payload.UserGroups"
},
"estimatedMinutes": {
"type": "integer"
},
"templateRoleName": {
"type": "string"
},
"descriptionContentType": {
"type": "string"
}
},
"description": "Task contains all the information returned from a task."
}
task.Workflows
{
"type": "object",
"title": "Workflows",
"properties": {
"stageId": {
"type": "integer"
},
"workflowId": {
"type": "integer"
},
"positionAfterTask": {
"type": "integer"
}
},
"description": "Workflows stores information about where the task lives in the workflow"
}
task.responseV205
{
"type": "object",
"title": "responseV205",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"task": {
"$ref": "#/components/schemas/view.TaskV205"
},
"affected": {
"$ref": "#/components/schemas/view.TaskAffectedV205"
},
"included": {
"$ref": "#/components/schemas/task.Included"
}
}
}
task.tasksResponseV205
{
"type": "object",
"title": "tasksResponseV205",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.TaskV205"
}
},
"included": {
"$ref": "#/components/schemas/task.Included"
}
}
}
tasklist.Response
{
"type": "object",
"title": "Response",
"properties": {
"included": {
"type": "object",
"properties": {
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.IncludedTask"
}
},
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"columns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.BoardColumn"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.IncludedProject"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"lockdowns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Lockdown"
}
},
"workflows": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Workflow"
}
},
"milestones": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Milestone"
}
},
"customfields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomField"
}
},
"notifications": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TasklistBudgetNotification"
}
},
"workflowStages": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Stage"
}
},
"tasklistBudgets": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TasklistBudget"
}
},
"customfieldTasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomFieldValueTask"
}
},
"tasklistTaskStats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskStats"
}
},
"defaultTaskReminders": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskReminder"
}
}
}
},
"tasklist": {
"$ref": "#/components/schemas/view.Tasklist"
}
},
"description": "Response contains information about a specific tasklist."
}
tasklist.TasklistsResponse
{
"type": "object",
"title": "TasklistsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.IncludedTask"
}
},
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"columns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.BoardColumn"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.IncludedProject"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"lockdowns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Lockdown"
}
},
"workflows": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Workflow"
}
},
"milestones": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Milestone"
}
},
"customfields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomField"
}
},
"notifications": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TasklistBudgetNotification"
}
},
"workflowStages": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Stage"
}
},
"tasklistBudgets": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TasklistBudget"
}
},
"customfieldTasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomFieldValueTask"
}
},
"tasklistTaskStats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskStats"
}
},
"defaultTaskReminders": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskReminder"
}
}
}
},
"tasklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Tasklist"
}
}
},
"description": "TasklistsResponse contains information about a group of tasklists."
}
tasklistbudget.Budget
{
"type": "object",
"title": "Budget",
"properties": {
"id": {
"type": "integer"
},
"capacity": {
"type": "integer"
},
"tasklist": {
"$ref": "#/components/schemas/tasklistbudget.tasklist"
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasklistbudget.notification"
}
}
},
"description": "Budget contains all the information returned from a budget."
}
tasklistbudget.BudgetResponse
{
"type": "object",
"title": "BudgetResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"tasklistBudget": {
"$ref": "#/components/schemas/view.TasklistBudget"
}
},
"description": "BudgetResponse contains information about a group of budgets."
}
tasklistbudget.BudgetsResponse
{
"type": "object",
"title": "BudgetsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"tasklists": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tasklist"
}
},
"notifications": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TasklistBudgetNotification"
}
},
"projectBudgets": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectBudget"
}
}
}
},
"tasklistBudgets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.TasklistBudget"
}
}
},
"description": "BudgetsResponse contains information about a group of budgets."
}
tasklistbudget.BulkAddBudgetRequest
{
"type": "object",
"title": "BulkAddBudgetRequest",
"properties": {
"tasklistBudgets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasklistbudget.Budget"
}
},
"tasklistBudgetsOptions": {
"$ref": "#/components/schemas/tasklistbudget.RequestOptions"
}
},
"description": "BulkAddBudgetRequest structure hold information needed to add\nor update task list budgets along with request options"
}
tasklistbudget.PatchBudgetRequest
{
"type": "object",
"title": "PatchBudgetRequest",
"properties": {
"tasklistBudget": {
"$ref": "#/components/schemas/tasklistbudget.Budget"
},
"tasklistBudgetOptions": {
"$ref": "#/components/schemas/tasklistbudget.RequestOptions"
}
},
"description": "PatchBudgetRequest Structure for the edit budget PATCH request"
}
tasklistbudget.RequestOptions
{
"type": "object",
"title": "RequestOptions",
"properties": {
"fireWebhook": {
"type": "boolean"
},
"logActivity": {
"type": "boolean"
},
"useNotifyViaTWIM": {
"type": "boolean"
}
},
"description": "RequestOptions has options for events related to requests"
}
tasklistbudget.company
{
"type": "object",
"title": "company",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
}
}
tasklistbudget.notification
{
"type": "object",
"title": "notification",
"properties": {
"id": {
"type": "integer"
},
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasklistbudget.team"
}
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasklistbudget.user"
}
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/tasklistbudget.company"
}
},
"capacityThreshold": {
"type": "number"
},
"notificationMedium": {
"type": "string"
}
}
}
tasklistbudget.tasklist
{
"type": "object",
"title": "tasklist",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
}
}
tasklistbudget.team
{
"type": "object",
"title": "team",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
}
}
tasklistbudget.user
{
"type": "object",
"title": "user",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
}
}