messagereply.Included
{
"type": "object",
"title": "Included",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"messages": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Message"
}
}
},
"description": "Included contains sideloadable stuff for message replies."
}
milestone.MilestonesResponse
{
"type": "object",
"title": "MilestonesResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"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"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"tasklists": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tasklist"
}
},
"projectCategories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectCategory"
}
},
"tasklistTaskStats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskStats"
}
}
}
},
"milestones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Milestone"
}
}
},
"description": "MilestonesResponse contains information about a group of milestones."
}
milestone.Response
{
"type": "object",
"title": "Response",
"properties": {
"included": {
"type": "object",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"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"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"tasklists": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tasklist"
}
},
"projectCategories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectCategory"
}
},
"tasklistTaskStats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskStats"
}
}
}
},
"milestone": {
"$ref": "#/components/schemas/view.Milestone"
}
},
"description": "Response contains information about a milestone."
}
notebook.Notebook
{
"type": "object",
"title": "Notebook",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"locked": {
"type": "boolean"
},
"notify": {
"$ref": "#/components/schemas/payload.Notify"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"privacy": {
"$ref": "#/components/schemas/payload.UserGroups"
},
"contents": {
"type": "string"
},
"sendDiff": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"categoryId": {
"type": "integer"
},
"newVersion": {
"type": "boolean"
},
"description": {
"type": "string"
},
"isFullWidth": {
"type": "boolean"
},
"secureContent": {
"type": "boolean"
},
"notifyCurrentUser": {
"type": "boolean"
}
},
"description": "Notebook contains all the information returned from a notebook."
}
notebook.NotebooksResponse
{
"type": "object",
"title": "NotebooksResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"notebookCategories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.NotebookCategory"
}
}
}
},
"notebooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Notebook"
}
}
},
"description": "NotebooksResponse contains information about a group of notebooks."
}
notebook.Request
{
"type": "object",
"title": "Request",
"properties": {
"notebook": {
"$ref": "#/components/schemas/notebook.Notebook"
}
},
"description": "Request contains information of a notebook to be created or updated."
}
notebook.Response
{
"type": "object",
"title": "Response",
"properties": {
"included": {
"type": "object",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"notebookCategories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.NotebookCategory"
}
}
}
},
"notebook": {
"$ref": "#/components/schemas/view.Notebook"
}
},
"description": "Response contains information about a specific notebook."
}
notebook.VersionResponse
{
"type": "object",
"title": "VersionResponse",
"properties": {
"version": {
"$ref": "#/components/schemas/view.NotebookVersion"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
}
}
}
},
"description": "VersionResponse contains information about a specifc notebook version"
}
notebook.VersionsResponse
{
"type": "object",
"title": "VersionsResponse",
"properties": {
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
}
}
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.NotebookVersion"
}
}
},
"description": "VersionsResponse contains information about a group of notebook versions"
}
notification.ProjectBudgetNotification
{
"type": "object",
"title": "ProjectBudgetNotification",
"properties": {
"id": {
"type": "integer"
},
"teamIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"userIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"budgetId": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"companyIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"capacityThreshold": {
"type": "number"
},
"notificationMedium": {
"type": "string"
}
},
"description": "ProjectBudgetNotification contains all the information returned from a notification."
}
notification.ProjectBudgetRequest
{
"type": "object",
"title": "ProjectBudgetRequest",
"properties": {
"notification": {
"$ref": "#/components/schemas/notification.ProjectBudgetNotification"
}
},
"description": "ProjectBudgetRequest contains information of a notification to be created or updated."
}
notification.Response
{
"type": "object",
"title": "Response",
"properties": {
"notification": {
"$ref": "#/components/schemas/view.Notification"
}
},
"description": "Response contains information about a specific notification."
}
owner.ProjectMetricOwner
{
"type": "object",
"title": "ProjectMetricOwner",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"description": "ProjectMetricOwner contains information about a specific owner."
}
owner.ProjectMetricOwnersResponse
{
"type": "object",
"title": "ProjectMetricOwnersResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/owner.ProjectMetricOwner"
}
},
"meta": {
"$ref": "#/components/schemas/view.Meta"
}
},
"description": "ProjectMetricOwnersResponse contains information about a group of owners."
}
payload.Date
{
"type": "object",
"title": "Date",
"description": "Date unmarshals represents a Unified API Spec date format."
}
payload.Notify
{
"type": "object",
"title": "Notify",
"properties": {
"ids": {
"$ref": "#/components/schemas/payload.UserGroups"
},
"type": {
"$ref": "#/components/schemas/payload.NotifyType"
}
},
"description": "Notify defines the access lists."
}
payload.NotifyType
{
"type": "object",
"title": "NotifyType",
"properties": {
"Set": {
"type": "boolean"
},
"Null": {
"type": "boolean"
},
"Value": {
"type": "string"
}
},
"description": "NotifyType implements json.Unmarshaler to allow testing between a value\nthat explicitly set to null or omitted."
}
payload.NullableDate
{
"type": "object",
"title": "NullableDate",
"properties": {
"Set": {
"type": "boolean"
},
"Null": {
"type": "boolean"
},
"Value": {
"$ref": "#/components/schemas/payload.Date"
}
},
"description": "NullableDate implements json.Unmarshaler to allow testing between a value\nthat explicitly set to null or omitted.\nDate format \"2006-01-02\""
}
payload.NullableInt64Slice
{
"type": "object",
"title": "NullableInt64Slice",
"properties": {
"Set": {
"type": "boolean"
},
"Null": {
"type": "boolean"
},
"Value": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "NullableInt64Slice implements json.Unmarshaler to allow testing between a\nvalue that explicitly set to null or omitted."
}
payload.NullableTaskPriority
{
"type": "object",
"title": "NullableTaskPriority",
"properties": {
"Set": {
"type": "boolean"
},
"Null": {
"type": "boolean"
},
"Value": {
"type": "string"
}
},
"description": "NullableTaskPriority implements json.Unmarshaler to allow testing\nbetween a value that explicitly set to null or omitted."
}
payload.NullableTaskRepeatFrequency
{
"type": "object",
"title": "NullableTaskRepeatFrequency",
"properties": {
"Set": {
"type": "boolean"
},
"Null": {
"type": "boolean"
},
"Value": {
"type": "string"
}
},
"description": "NullableTaskRepeatFrequency implements json.Unmarshaler to allow testing\nbetween a value that explicitly set to null or omitted."
}
payload.NullableTaskRepeatMonthlyType
{
"type": "object",
"title": "NullableTaskRepeatMonthlyType",
"properties": {
"Set": {
"type": "boolean"
},
"Null": {
"type": "boolean"
},
"Value": {
"type": "string"
}
},
"description": "NullableTaskRepeatMonthlyType implements json.Unmarshaler to allow testing\nbetween a value that explicitly set to null or omitted."
}
payload.NullableWorkingHourEntryWeekdays
{
"type": "object",
"title": "NullableWorkingHourEntryWeekdays",
"properties": {
"Set": {
"type": "boolean"
},
"Null": {
"type": "boolean"
},
"Value": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "NullableWorkingHourEntryWeekdays implements json.Unmarshaler to allow testing\nbetween a value that explicitly set to null or omitted."
}
payload.Time
{
"type": "object",
"title": "Time",
"description": "Time unmarshals represents a Unified API Spec date format."
}
payload.UserGroups
{
"type": "object",
"title": "UserGroups",
"properties": {
"teamIds": {
"$ref": "#/components/schemas/payload.NullableInt64Slice"
},
"userIds": {
"$ref": "#/components/schemas/payload.NullableInt64Slice"
},
"companyIds": {
"$ref": "#/components/schemas/payload.NullableInt64Slice"
}
},
"description": "UserGroups are common lists for storing users, companies and teams ids\ntogether."
}
people.AddPeopleToProjectResponse
{
"type": "object",
"title": "AddPeopleToProjectResponse",
"properties": {
"info": {
"type": "array",
"items": {
"type": "string"
}
},
"teamIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"usersAdded": {
"type": "array",
"items": {
"type": "integer"
}
},
"usersNotAdded": {
"type": "array",
"items": {
"type": "integer"
}
},
"usersAlreadyInProject": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "AddPeopleToProjectResponse contains information about which users were and weren't add to the project as well\nas why the users were not able to be added"
}
people.MultiResponse
{
"type": "object",
"title": "MultiResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"people": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.User"
}
},
"included": {
"type": "object",
"properties": {
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"workingHours": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.WorkingHour"
}
},
"ProjectPermissions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectPermissions"
}
}
}
}
},
"description": "MultiResponse contains information about a group of users."
}
people.Response
{
"type": "object",
"title": "Response",
"properties": {
"person": {
"$ref": "#/components/schemas/view.User"
},
"included": {
"type": "object",
"properties": {
"teams": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Team"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"workingHours": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.WorkingHour"
}
},
"ProjectPermissions": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectPermissions"
}
}
}
}
},
"description": "Response contains information about a user."
}
people.TaskCompletion
{
"type": "object",
"title": "TaskCompletion",
"properties": {
"userId": {
"type": "integer"
},
"overdueTasks": {
"type": "integer"
},
"assignedTasks": {
"type": "integer"
},
"activeProjects": {
"type": "integer"
},
"completedTasks": {
"type": "integer"
}
},
"description": "TaskCompletion contains information about tasks completed by a user."
}
people.TaskCompletionResponse
{
"type": "object",
"title": "TaskCompletionResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
}
}
},
"taskCompletions": {
"$ref": "#/components/schemas/people.TaskCompletions"
}
},
"description": "TaskCompletionResponse contains information about tasks completed by a user."
}
people.TaskCompletions
{
"type": "object",
"title": "TaskCompletions",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/people.TaskCompletion"
}
},
"totalOverdueTasks": {
"type": "integer"
},
"totalAssignedTasks": {
"type": "integer"
},
"totalActiveProjects": {
"type": "integer"
},
"totalCompletedTasks": {
"type": "integer"
}
},
"description": "TaskCompletions represents a summary row of total computed counts of, plus individual user data\n/reporting/precanned/usertaskcompletions.json endpoint"
}
people.UsersPayload
{
"type": "object",
"title": "UsersPayload",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"checkTeamIds": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "UsersPayload consists of userIDs"
}
performance.PeopleMetricPerformance
{
"type": "object",
"title": "PeopleMetricPerformance",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"description": "PeopleMetricPerformance contains all the information returned from a performance."
}
performance.PeopleMetricPerformancesResponse
{
"type": "object",
"title": "PeopleMetricPerformancesResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/performance.PeopleMetricPerformance"
}
}
},
"description": "PeopleMetricPerformancesResponse contains information about a group of performances."
}
planner.WorkloadPlanner
{
"type": "object",
"title": "WorkloadPlanner",
"properties": {
"user": {
"$ref": "#/components/schemas/view.Relationship"
},
"userId": {
"type": "integer"
},
"capacities": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/planner.WorkloadPlannerCapacity"
}
}
},
"description": "WorkloadPlanner contains all the information returned from a planner."
}
planner.WorkloadPlannerCapacity
{
"type": "object",
"title": "WorkloadPlannerCapacity",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/planner.WorkloadPlannerCapacityTask"
}
},
"capacity": {
"type": "number",
"description": "percentage"
},
"lengthOfDayMinutes": {
"type": "number"
},
"estimateMinutesTotal": {
"type": "number"
}
},
"description": "WorkloadPlannerCapacity contains the information regarding an user on a\nspecific date."
}
planner.WorkloadPlannerCapacityTask
{
"type": "object",
"title": "WorkloadPlannerCapacityTask",
"properties": {
"taskId": {
"type": "integer"
},
"estimateMinutes": {
"type": "number"
}
},
"description": "WorkloadPlannerCapacityTask provides how many minutes should a user work in a\ntask for a specific date."
}
planner.WorkloadPlannersResponse
{
"type": "object",
"title": "WorkloadPlannersResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"tasks": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskV205"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"timelogs": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Timelog"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"tasklists": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tasklist"
}
},
"milestones": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Milestone"
}
},
"workingHours": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.WorkingHour"
}
},
"calendarEvents": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.LegacyCalendarEvent"
}
},
"workingHourEntries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.WorkingHourEntry"
}
}
}
},
"planners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/planner.WorkloadPlanner"
}
}
},
"description": "WorkloadPlannersResponse contains information about a group of planners."
}
priceplan.FeaturesResponse
{
"type": "object",
"title": "FeaturesResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Feature"
}
}
},
"description": "FeaturesResponse contains all the information returned when sending a GET\nrequest to the features endpoint."
}
project.FeatureOrder
{
"type": "object",
"title": "FeatureOrder",
"properties": {
"id": {
"type": "integer"
},
"list": {
"type": "integer"
},
"time": {
"type": "integer"
},
"board": {
"type": "integer"
},
"files": {
"type": "integer"
},
"forms": {
"type": "integer"
},
"gantt": {
"type": "integer"
},
"links": {
"type": "integer"
},
"risks": {
"type": "integer"
},
"table": {
"type": "integer"
},
"people": {
"type": "integer"
},
"proofs": {
"type": "integer"
},
"billing": {
"type": "integer"
},
"finance": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"messages": {
"type": "integer"
},
"settings": {
"type": "integer"
},
"dashboard": {
"type": "integer"
},
"notebooks": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"milestones": {
"type": "integer"
},
"installationId": {
"type": "integer"
},
"numVisibleTabs": {
"type": "integer"
}
},
"description": "FeatureOrder contains the information of the feature\norder to display in the UI for a project."
}
project.FeatureOrderDefaults
{
"type": "object",
"title": "FeatureOrderDefaults",
"properties": {
"list": {
"type": "integer"
},
"time": {
"type": "integer"
},
"board": {
"type": "integer"
},
"files": {
"type": "integer"
},
"forms": {
"type": "integer"
},
"gantt": {
"type": "integer"
},
"links": {
"type": "integer"
},
"risks": {
"type": "integer"
},
"table": {
"type": "integer"
},
"people": {
"type": "integer"
},
"proofs": {
"type": "integer"
},
"billing": {
"type": "integer"
},
"finance": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"messages": {
"type": "integer"
},
"settings": {
"type": "integer"
},
"dashboard": {
"type": "integer"
},
"notebooks": {
"type": "integer"
},
"milestones": {
"type": "integer"
},
"numVisibleTabs": {
"type": "integer"
}
},
"description": "FeatureOrderDefaults is the payload used to set\nthe defaults for all projects feature order, and\nallows to also update the projects that have\nan explicitly set defaults"
}
project.FeatureOrderRequest
{
"type": "object",
"title": "FeatureOrderRequest",
"properties": {
"featureOrder": {
"$ref": "#/components/schemas/project.FeatureOrder"
},
"featureOrderOptions": {
"type": "object",
"properties": {
"useNotifyViaTWIM": {
"type": "boolean"
}
}
}
},
"description": "FeatureOrderRequest is the payload used to set\nthe project features order as we want to appear\nin the UI tabs selection"
}
project.FeatureOrderResponse
{
"type": "object",
"title": "FeatureOrderResponse",
"properties": {
"featureOrder": {
"$ref": "#/components/schemas/project.FeatureOrder"
}
},
"description": "FeatureOrderResponse is the api response containing\ninformation about the order to display the featues in the UI."
}
project.Included
{
"type": "object",
"title": "Included",
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Tag"
}
},
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"stages": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Stage"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
},
"countries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Country"
}
},
"workflows": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Workflow"
}
},
"activities": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ActivityLog"
}
},
"industries": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Industry"
}
},
"customfields": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomField"
}
},
"portfolioCards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.PortfolioCard"
}
},
"projectBudgets": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectBudget"
}
},
"projectUpdates": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectUpdate"
}
},
"portfolioBoards": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.PortfolioBoard"
}
},
"portfolioColumns": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.PortfolioColumn"
}
},
"projectTaskStats": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.TaskStats"
}
},
"projectCategories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectCategory"
}
},
"customfieldProjects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.CustomFieldValueProject"
}
},
"projectEmailDropboxes": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectEmailDropbox"
}
}
},
"description": "Included is the task sideloads"
}
project.SampleProjectsResponse
{
"type": "object",
"title": "SampleProjectsResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"projectCategories": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectCategory"
}
}
}
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.SampleProject"
}
}
},
"description": "SampleProjectsResponse contains information about a group of sample projects."
}
project.projectsResponseV205
{
"type": "object",
"title": "projectsResponseV205",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"$ref": "#/components/schemas/project.Included"
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.ProjectV205"
}
}
},
"description": "projectsResponseV205 contains information about a group of projects."
}
project.responseV205
{
"type": "object",
"title": "responseV205",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"project": {
"$ref": "#/components/schemas/view.ProjectV205"
},
"included": {
"$ref": "#/components/schemas/project.Included"
}
},
"description": "responseV205 contains information about a project."
}
risk.RisksResponse
{
"type": "object",
"title": "RisksResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"risks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Risk"
}
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"projects": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.ProjectV205"
}
},
"companies": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.Company"
}
}
}
}
},
"description": "RisksResponse contains all the information returned when sending a GET\nrequest to the risk endpoint."
}
status.TimelineResponse
{
"type": "object",
"title": "TimelineResponse",
"properties": {
"meta": {
"$ref": "#/components/schemas/view.Meta"
},
"included": {
"type": "object",
"properties": {
"users": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.User"
}
},
"userEvents": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.UserEvents"
}
}
}
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Status"
}
}
},
"description": "TimelineResponse contains information about a group of statuses."
}
summary.ColumnCardResponse
{
"type": "object",
"title": "ColumnCardResponse",
"properties": {
"count": {
"type": "integer"
},
"active": {
"type": "integer"
},
"archived": {
"type": "integer"
},
"completed": {
"type": "integer"
}
},
"description": "ColumnCardResponse contains counters from column's cards."
}