view.CustomFieldValueCompany
{
"type": "object",
"title": "CustomFieldValueCompany",
"properties": {
"id": {
"type": "integer"
},
"value": {},
"company": {
"$ref": "#/components/schemas/view.Relationship"
},
"companyId": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"countryCode": {
"type": "string"
},
"customfield": {
"$ref": "#/components/schemas/view.Relationship"
},
"customfieldId": {
"type": "integer"
},
"currencySymbol": {
"type": "string"
},
"urlTextToDisplay": {
"type": "string"
}
},
"description": "CustomFieldValueCompany is a company custom field value."
}
view.CustomFieldValueProject
{
"type": "object",
"title": "CustomFieldValueProject",
"properties": {
"id": {
"type": "integer"
},
"value": {},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"countryCode": {
"type": "string"
},
"customfield": {
"$ref": "#/components/schemas/view.Relationship"
},
"customfieldId": {
"type": "integer"
},
"currencySymbol": {
"type": "string"
},
"urlTextToDisplay": {
"type": "string"
}
},
"description": "CustomFieldValueProject is a project custom field value."
}
view.CustomFieldValueTask
{
"type": "object",
"title": "CustomFieldValueTask",
"properties": {
"id": {
"type": "integer"
},
"task": {
"$ref": "#/components/schemas/view.Relationship"
},
"value": {},
"taskId": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"countryCode": {
"type": "string"
},
"customfield": {
"$ref": "#/components/schemas/view.Relationship"
},
"customfieldId": {
"type": "integer"
},
"currencySymbol": {
"type": "string"
},
"urlTextToDisplay": {
"type": "string"
}
},
"description": "CustomFieldValueTask is a task custom field value."
}
view.Date
{
"type": "object",
"title": "Date",
"description": "Date represents a Unified API Spec date format."
}
view.EffectiveUserRate
{
"type": "object",
"title": "EffectiveUserRate",
"properties": {
"user": {
"$ref": "#/components/schemas/view.Relationship"
},
"effectiveRate": {
"type": "integer"
}
},
"description": "EffectiveUserRate is the users effective rate"
}
view.Error
{
"type": "object",
"title": "Error",
"properties": {
"id": {
"type": "string",
"description": "ID is a reference for this exact instance of the error."
},
"code": {
"type": "string",
"description": "Code is an application-specific error code."
},
"meta": {
"type": "object",
"description": "Meta contains tags that are useful to detect specific issues."
},
"title": {
"type": "string",
"description": "Title is a short, human-readable summary of the problem."
},
"detail": {
"type": "string",
"description": "Detail is a human-readable explanation specific to this occurrence of the\nproblem."
}
},
"description": "Error describes an API error."
}
view.ErrorResponse
{
"type": "object",
"title": "ErrorResponse",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Error"
}
}
},
"description": "ErrorResponse defines how []Error should be marshaled to JSON."
}
view.Feature
{
"type": "object",
"title": "Feature",
"properties": {
"key": {
"type": "string"
},
"endAt": {
"type": "string"
},
"scope": {
"type": "string"
},
"value": {
"type": "string"
},
"isBeta": {
"type": "boolean"
},
"source": {
"type": "string"
},
"startAt": {
"type": "string"
}
},
"description": "Feature contains all the information returned from a feature."
}
view.FileversionV205
{
"type": "object",
"title": "FileversionV205",
"properties": {
"file": {
"$ref": "#/components/schemas/view.Relationship"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"fileId": {
"type": "integer"
},
"status": {
"type": "string"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"projectId": {
"type": "integer"
},
"reactions": {
"$ref": "#/components/schemas/view.ReactionsForObject"
},
"versionNo": {
"type": "integer"
},
"uploadedAt": {
"type": "string"
},
"uploadedBy": {
"type": "integer"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"originalName": {
"type": "string"
},
"commentsCount": {
"type": "integer"
},
"fileVersionId": {
"type": "integer"
},
"commentsCountRead": {
"type": "integer"
}
},
"description": "FileversionV205 contains all the information returned from a fileversion."
}
view.Form
{
"type": "object",
"title": "Form",
"properties": {
"id": {
"type": "integer"
},
"state": {
"type": "string"
},
"token": {
"$ref": "#/components/schemas/view.Token"
},
"content": {
"$ref": "#/components/schemas/view.Content"
},
"isShared": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"hostObject": {
"$ref": "#/components/schemas/view.Relationship"
},
"redirectUrl": {
"type": "string"
},
"installation": {
"$ref": "#/components/schemas/view.Relationship"
},
"primaryColor": {
"type": "string"
},
"submitButtonText": {
"type": "string"
},
"taskTitleFieldId": {
"type": "string"
},
"totalSubmissions": {
"type": "integer"
},
"destinationObject": {
"$ref": "#/components/schemas/view.Relationship"
},
"confirmationMessage": {
"type": "string"
},
"responseEmailFieldId": {
"type": "string"
},
"allowTeamworkBranding": {
"type": "boolean"
},
"promptAdditionalSubmissions": {
"type": "boolean"
}
},
"description": "Form contains all the information returned from a form."
}
view.IncludedProject
{
"type": "object",
"title": "IncludedProject",
"description": "IncludedProject is a sideloaded project"
}
view.IncludedTask
{
"type": "object",
"title": "IncludedTask",
"description": "IncludedTask is a sideloaded task."
}
view.Industry
{
"type": "object",
"title": "Industry",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"isPublished": {
"type": "boolean"
},
"displayOrder": {
"type": "integer"
},
"industryCategory": {
"$ref": "#/components/schemas/view.Relationship"
},
"industryCategoryId": {
"type": "integer"
}
},
"description": "Industry contains all the information returned from an industry."
}
view.LegacyCalendarEvent
{
"type": "object",
"title": "LegacyCalendarEvent",
"properties": {
"id": {
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/view.Relationship"
},
"title": {
"type": "string"
},
"allDay": {
"type": "boolean"
},
"typeId": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"endDate": {
"type": "string"
},
"ownedBy": {
"type": "integer"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"location": {
"type": "string"
},
"sequence": {
"$ref": "#/components/schemas/view.Relationship"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"startDate": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"type": "integer"
},
"sequenceId": {
"type": "integer"
},
"showAsBusy": {
"type": "boolean"
},
"dateDeleted": {
"type": "string"
},
"description": {
"type": "string"
},
"ownerUserId": {
"type": "integer"
},
"privacyType": {
"type": "string"
},
"attendingUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"createdByUserId": {
"type": "integer"
},
"createdDateTime": {
"type": "string"
},
"dateLastUpdated": {
"type": "string"
},
"deletedByUserId": {
"type": "integer"
},
"updatedByUserId": {
"type": "integer"
},
"attendeesCanEdit": {
"type": "boolean"
},
"attendingUserIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"monthlyRepeatType": {
"type": "string"
},
"projectUsersCanEdit": {
"type": "boolean"
},
"additionalProperties": {
"type": "string"
},
"currentUserAssociationType": {
"type": "string"
}
},
"description": "LegacyCalendarEvent contains all the information returned from a calendar event."
}
view.LegacyCalendarEventType
{
"type": "object",
"title": "LegacyCalendarEventType",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"unavailable": {
"type": "boolean"
}
},
"description": "LegacyCalendarEventType contains all the information returned from a calendar event\ntype."
}
view.LegacyUnavailableTime
{
"type": "object",
"title": "LegacyUnavailableTime",
"properties": {
"id": {
"type": "integer"
},
"meta": {
"type": "object"
},
"type": {
"$ref": "#/components/schemas/view.Relationship"
},
"title": {
"type": "string"
},
"allDay": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"endDate": {
"$ref": "#/components/schemas/view.Date"
},
"ownedBy": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"type": "integer"
},
"startDate": {
"$ref": "#/components/schemas/view.Date"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"type": "integer"
},
"description": {
"type": "string"
},
"hoursPerDay": {
"type": "number"
},
"attendingUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"durationMinutes": {
"type": "integer"
}
},
"description": "LegacyUnavailableTime contains all the information returned for an unavailable\ntime."
}
view.LinkItem
{
"type": "object",
"title": "LinkItem",
"properties": {
"id": {
"type": "integer"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"category": {
"$ref": "#/components/schemas/view.Relationship"
},
"provider": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"type": "integer"
},
"isPrivate": {
"type": "boolean"
},
"projectId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"type": "integer"
},
"categoryId": {
"type": "integer"
},
"description": {
"type": "string"
},
"forceNewWindow": {
"type": "integer"
}
},
"description": "LinkItem contains all the information returned from a link item."
}
view.Lockdown
{
"type": "object",
"title": "Lockdown",
"properties": {
"id": {
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/view.Relationship"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"userID": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"grantAccessTo": {
"$ref": "#/components/schemas/view.UserGroupsDeprecated"
}
},
"description": "Lockdown contains all the information returned from a lockdown."
}
view.Logo
{
"type": "object",
"title": "Logo",
"properties": {
"url": {
"type": "string"
}
},
"description": "Logo contains all the information returned from a form custom logo."
}
view.Message
{
"type": "object",
"title": "Message",
"properties": {
"id": {
"type": "integer"
},
"body": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/view.MessageReplyMeta"
},
"title": {
"type": "string"
},
"author": {
"$ref": "#/components/schemas/view.Relationship"
},
"status": {
"type": "string"
},
"message": {
"$ref": "#/components/schemas/view.Relationship"
},
"lockdown": {
"$ref": "#/components/schemas/view.Relationship"
},
"createdAt": {
"type": "string"
},
"projectId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"peopleNotifiedCount": {
"type": "integer"
}
},
"description": "Message contains all the information returned from a project message."
}
view.MessageReply
{
"type": "object",
"title": "MessageReply",
"properties": {
"id": {
"type": "integer"
},
"body": {
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/view.MessageReplyMeta"
},
"author": {
"$ref": "#/components/schemas/view.Relationship"
},
"status": {
"type": "string"
},
"message": {
"$ref": "#/components/schemas/view.Relationship"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"peopleNotifiedCount": {
"type": "integer"
}
},
"description": "MessageReply contains all the information returned from a project message."
}
view.MessageReplyMeta
{
"type": "object",
"title": "MessageReplyMeta",
"properties": {
"isRead": {
"type": "boolean"
},
"permissions": {
"type": "object",
"properties": {
"canEdit": {
"type": "boolean"
}
}
}
},
"description": "MessageReplyMeta is the message reply meta."
}
view.Meta
{
"type": "object",
"title": "Meta",
"properties": {
"page": {
"$ref": "#/components/schemas/view.MetaPage"
},
"limit": {
"type": "integer"
},
"nextCursor": {
"type": "string"
},
"prevCursor": {
"type": "string"
},
"averageSpend": {
"type": "integer"
},
"totalCapacity": {
"type": "integer"
}
},
"description": "Meta represents the Unified API meta object."
}
view.MetaPage
{
"type": "object",
"title": "MetaPage",
"properties": {
"count": {
"type": "integer"
},
"hasMore": {
"type": "boolean"
},
"pageSize": {
"type": "integer"
},
"pageOffset": {
"type": "integer"
}
},
"description": "MetaPage represents the Unified API page meta object."
}
view.Milestone
{
"type": "object",
"title": "Milestone",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"status": {
"type": "string"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"canEdit": {
"type": "boolean",
"description": "permissions"
},
"private": {
"type": "boolean"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"deadline": {
"type": "string"
},
"lockdown": {
"$ref": "#/components/schemas/view.Relationship"
},
"reminder": {
"type": "boolean"
},
"completed": {
"type": "boolean"
},
"createdBy": {
"type": "integer"
},
"createdOn": {
"type": "string"
},
"isDeleted": {
"type": "boolean"
},
"projectId": {
"type": "integer"
},
"tasklists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"updatedBy": {
"type": "integer"
},
"lockdownId": {
"type": "integer"
},
"canComplete": {
"type": "boolean"
},
"completedBy": {
"type": "integer"
},
"completedOn": {
"type": "string"
},
"completerId": {
"type": "integer"
},
"description": {
"type": "string"
},
"tasklistIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"commentsCount": {
"type": "integer"
},
"creatorUserId": {
"type": "integer"
},
"lastChangedOn": {
"type": "string"
},
"latestUpdates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Audit"
}
},
"changeFollowers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"descriptionHTML": {
"type": "string"
},
"numCommentsRead": {
"type": "integer"
},
"originalDueDate": {
"type": "string"
},
"commentFollowers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"changeFollowerIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"commentFollowerIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"percentageComplete": {
"type": "integer"
},
"responsibleParties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"responsiblePartyIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "optional fields that are returned only when querying a milestone endpoint"
},
"userFollowingChanges": {
"type": "boolean"
},
"userFollowingComments": {
"type": "boolean"
},
"percentageTasksCompleted": {
"type": "integer"
}
},
"description": "Milestone contains all the information returned from a milestone."
}
view.MyTimesheet
{
"type": "object",
"title": "MyTimesheet",
"properties": {
"dates": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/view.MyTimesheetDateSummary"
}
},
"total": {
"type": "integer"
},
"entity": {
"$ref": "#/components/schemas/view.Relationship"
},
"customRow": {
"$ref": "#/components/schemas/view.Relationship"
},
"isCustomRow": {
"type": "boolean"
}
},
"description": "MyTimesheet contains api response information for a timesheet"
}
view.MyTimesheetDateSummary
{
"type": "object",
"title": "MyTimesheetDateSummary",
"properties": {
"timelogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"totalMinutes": {
"type": "integer"
}
},
"description": "MyTimesheetDateSummary contains total minutes and timelog ids for a date"
}
view.Notebook
{
"type": "object",
"title": "Notebook",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"type": {
"type": "string"
},
"locked": {
"type": "boolean"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"deleted": {
"type": "boolean"
},
"privacy": {
"$ref": "#/components/schemas/view.UserGroupsDeprecated"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"category": {
"$ref": "#/components/schemas/view.Relationship"
},
"contents": {
"type": "string",
"description": "can be optionally hidden on lists"
},
"lockdown": {
"$ref": "#/components/schemas/view.Relationship"
},
"lockedAt": {
"type": "string"
},
"lockedBy": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"type": "integer"
},
"isPrivate": {
"type": "boolean"
},
"projectId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"type": "integer"
},
"categoryId": {
"type": "integer"
},
"lockdownId": {
"type": "integer"
},
"contentHTML": {
"type": "string"
},
"dateCreated": {
"type": "string"
},
"dateDeleted": {
"type": "string"
},
"dateUpdated": {
"type": "string"
},
"description": {
"type": "string"
},
"isFullWidth": {
"type": "boolean"
},
"versionCount": {
"type": "integer"
},
"commentsCount": {
"type": "integer"
},
"secureContent": {
"type": "boolean"
},
"changeFollowers": {
"$ref": "#/components/schemas/view.UserGroupsDeprecated"
},
"createdByUserID": {
"type": "integer"
},
"deletedByUserID": {
"type": "integer"
},
"latestVersionNo": {
"type": "integer"
},
"notebookVersion": {
"$ref": "#/components/schemas/view.Relationship"
},
"updatedByUserID": {
"type": "integer"
},
"commentFollowers": {
"$ref": "#/components/schemas/view.UserGroupsDeprecated"
},
"notebookVersionID": {
"type": "integer"
},
"readCommentsCount": {
"type": "integer"
},
"userFollowingChanges": {
"type": "boolean"
},
"userFollowingComments": {
"type": "boolean"
},
"notebookVersionCreatedDateTime": {
"type": "string"
},
"notebookVersionUpdatedDateTime": {
"type": "string"
}
},
"description": "Notebook contains all the information returned from a notebook."
}
view.NotebookCategory
{
"type": "object",
"title": "NotebookCategory",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"parent": {
"$ref": "#/components/schemas/view.Relationship"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"parentId": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"elementsCount": {
"type": "integer"
}
},
"description": "NotebookCategory contains all the information returned from a notebook category."
}
view.NotebookVersion
{
"type": "object",
"title": "NotebookVersion",
"properties": {
"contents": {
"type": "string"
},
"notebook": {
"$ref": "#/components/schemas/view.Relationship"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"versionId": {
"type": "integer"
},
"notebookId": {
"type": "integer"
},
"contentHTML": {
"type": "string"
},
"dateCreated": {
"type": "string"
},
"dateUpdated": {
"type": "string"
},
"versionNumber": {
"type": "integer"
},
"createdByUserID": {
"type": "integer"
}
},
"description": "NotebookVersion contains all the information returned from a notebook version."
}
view.Notification
{
"type": "object",
"title": "Notification",
"properties": {
"id": {
"type": "integer"
},
"date": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/view.NotificationItem"
},
"link": {
"type": "string"
},
"read": {
"type": "boolean"
},
"user": {
"$ref": "#/components/schemas/view.NotificationUser"
},
"event": {
"type": "string"
},
"popUp": {
"type": "boolean"
},
"action": {
"type": "string"
},
"command": {
"type": "string"
},
"privacy": {
"$ref": "#/components/schemas/view.NotificationPrivacy"
},
"project": {
"$ref": "#/components/schemas/view.NotificationProject"
},
"extraInfo": {
"type": "string"
},
"extraLink": {
"type": "string"
},
"description": {
"type": "string"
},
"installation": {
"$ref": "#/components/schemas/view.Relationship"
},
"extraDescription": {
"type": "string"
}
},
"description": "Notification contains all the information returned from a notification."
}
view.NotificationItem
{
"type": "object",
"title": "NotificationItem",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"description": "NotificationItem contains the id and type being of what is being notified"
}
view.NotificationPrivacy
{
"type": "object",
"title": "NotificationPrivacy",
"properties": {
"private": {
"type": "boolean"
},
"lockdownId": {
"type": "integer"
}
},
"description": "NotificationPrivacy contains if the notification links to a private item"
}
view.NotificationProject
{
"type": "object",
"title": "NotificationProject",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"description": "NotificationProject contains the project ID & and name of the associated notification"
}
view.NotificationUser
{
"type": "object",
"title": "NotificationUser",
"properties": {
"id": {
"type": "integer"
},
"lastname": {
"type": "string"
},
"firstname": {
"type": "string"
},
"avatar_url": {
"type": "string"
}
},
"description": "NotificationUser contains the user information for the notification"
}
view.PortfolioBoard
{
"type": "object",
"title": "PortfolioBoard",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
}
},
"description": "PortfolioBoard contains all the information returned from a portfolio board."
}
view.PortfolioCard
{
"type": "object",
"title": "PortfolioCard",
"properties": {
"id": {
"type": "integer"
},
"board": {
"$ref": "#/components/schemas/view.Relationship"
},
"column": {
"$ref": "#/components/schemas/view.Relationship"
},
"boardId": {
"type": "integer"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"columnId": {
"type": "integer"
},
"projectId": {
"type": "integer"
}
},
"description": "PortfolioCard contains all the information returned from a portfolio\ncolumn."
}
view.PortfolioColumn
{
"type": "object",
"title": "PortfolioColumn",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
}
},
"description": "PortfolioColumn contains all the information returned from a portfolio\ncolumn."
}
view.ProfitDetails
{
"type": "object",
"title": "ProfitDetails",
"properties": {
"cost": {
"type": "number"
},
"profit": {
"type": "number"
},
"billable": {
"type": "number"
},
"expenses": {
"type": "number"
},
"loggedTime": {
"type": "integer"
},
"billableTime": {
"type": "integer"
},
"nonBillableTime": {
"type": "integer"
}
},
"description": "ProfitDetails represents the totals."
}
view.ProjectBudget
{
"type": "object",
"title": "ProjectBudget",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
},
"status": {
"type": "string"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"capacity": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"type": "integer"
},
"isRetainer": {
"type": "boolean"
},
"repeatUnit": {
"type": "string"
},
"completedAt": {
"type": "string"
},
"completedBy": {
"type": "integer"
},
"dateCreated": {
"type": "string"
},
"dateDeleted": {
"type": "string"
},
"dateUpdated": {
"type": "string"
},
"defaultRate": {
"type": "number"
},
"endDateTime": {
"type": "string"
},
"expenseType": {
"type": "string"
},
"isRepeating": {
"type": "boolean"
},
"overspendAt": {
"type": "string"
},
"timelogType": {
"type": "string"
},
"capacityUsed": {
"type": "integer"
},
"currencyCode": {
"type": "string"
},
"repeatPeriod": {
"type": "integer"
},
"carryCapacity": {
"type": "integer"
},
"dateCompleted": {
"type": "string"
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"startDateTime": {
"type": "string"
},
"budgetCategory": {
"type": "string"
},
"carryOverspend": {
"type": "boolean"
},
"sequenceNumber": {
"type": "integer"
},
"carryUnderspend": {
"type": "boolean"
},
"createdByUserId": {
"type": "integer"
},
"deletedByUserId": {
"type": "integer"
},
"notificationIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"updatedByUserId": {
"type": "integer"
},
"baselineCapacity": {
"type": "integer"
},
"originatorBudget": {
"$ref": "#/components/schemas/view.Relationship"
},
"repeatsRemaining": {
"type": "integer"
},
"completedByUserId": {
"type": "integer"
},
"budgetExpectedCost": {
"type": "integer"
},
"budgetProfitMargin": {
"type": "number"
},
"originatorBudgetId": {
"type": "integer"
},
"budgetExpectedProfit": {
"type": "integer"
},
"originatorStartDateTime": {
"type": "string"
}
},
"description": "ProjectBudget contains all the information returned from a budget."
}
view.ProjectCategory
{
"type": "object",
"title": "ProjectCategory",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"count": {
"type": "integer"
},
"parent": {
"$ref": "#/components/schemas/view.Relationship"
},
"parentId": {
"type": "integer"
}
},
"description": "ProjectCategory contains all the information returned from a project\ncategory."
}
view.ProjectEmailDropbox
{
"type": "object",
"title": "ProjectEmailDropbox",
"properties": {
"id": {
"type": "integer"
},
"parent": {
"$ref": "#/components/schemas/view.Relationship"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"itemCode": {
"type": "string"
},
"itemType": {
"type": "string"
},
"itemEmail": {
"type": "string"
},
"projectCode": {
"type": "string"
},
"projectEmails": {
"$ref": "#/components/schemas/view.ProjectEmails"
}
},
"description": "ProjectEmailDropbox contains all the information returned from a file\ncategory."
}
view.ProjectEmails
{
"type": "object",
"title": "ProjectEmails",
"properties": {
"files": {
"type": "string"
},
"links": {
"type": "string"
},
"tasks": {
"type": "string"
},
"messages": {
"type": "string"
},
"notebooks": {
"type": "string"
}
},
"description": "ProjectEmails is the project emails."
}
view.ProjectFileV205
{
"type": "object",
"title": "ProjectFileV205",
"properties": {
"id": {
"type": "integer"
},
"meta": {
"type": "object"
},
"size": {
"type": "integer"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"status": {
"type": "string"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"version": {
"$ref": "#/components/schemas/view.Relationship"
},
"category": {
"$ref": "#/components/schemas/view.Relationship"
},
"isLocked": {
"type": "boolean"
},
"lockdown": {
"$ref": "#/components/schemas/view.Relationship"
},
"lockedAt": {
"type": "string"
},
"lockedBy": {
"type": "integer"
},
"numLikes": {
"type": "integer"
},
"thumbURL": {
"type": "string"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.FileversionV205"
}
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"type": "integer"
},
"extraData": {
"type": "string"
},
"isPrivate": {
"enum": [
"0",
"1",
"2"
],
"type": "string",
"description": "IsPrivate can have the values 0 for public, 1 for private and 2 for\ninherited."
},
"projectId": {
"type": "integer"
},
"reactions": {
"$ref": "#/components/schemas/view.ReactionsForObject"
},
"updatedAt": {
"type": "string"
},
"versionId": {
"type": "integer"
},
"categoryId": {
"type": "integer"
},
"fileSource": {
"type": "string"
},
"lockdownId": {
"type": "integer"
},
"lockedDate": {
"type": "string"
},
"previewURL": {
"type": "string"
},
"uploadedAt": {
"type": "string"
},
"uploadedBy": {
"type": "integer"
},
"description": {
"type": "string"
},
"displayName": {
"type": "string"
},
"downloadURL": {
"type": "string"
},
"originalName": {
"type": "string"
},
"relatedItems": {
"$ref": "#/components/schemas/view.RelatedItems"
},
"uploadedDate": {
"type": "string"
},
"commentsCount": {
"type": "integer"
},
"filenameOnDisk": {
"type": "string"
},
"lockedByUserId": {
"type": "integer"
},
"changeFollowers": {
"$ref": "#/components/schemas/view.UserGroupsDeprecated"
},
"commentFollowers": {
"$ref": "#/components/schemas/view.UserGroupsDeprecated"
},
"uploadedByUserID": {
"type": "integer"
},
"commentsCountRead": {
"type": "integer"
},
"latestFileVersionNo": {
"type": "integer"
}
},
"description": "ProjectFileV205 contains all the information returned from a file."
}
view.ProjectMinMaxAvailableDates
{
"type": "object",
"title": "ProjectMinMaxAvailableDates",
"properties": {
"maxEndDate": {
"type": "string"
},
"minStartDate": {
"type": "string"
},
"deadlinesFound": {
"type": "boolean"
},
"suggestedEndDate": {
"type": "string"
},
"suggestedStartDate": {
"type": "string"
}
},
"description": "ProjectMinMaxAvailableDates shows suggested start and\nend dates for a project."
}
view.ProjectPermissions
{
"type": "object",
"title": "ProjectPermissions",
"properties": {
"active": {
"type": "boolean"
},
"addTime": {
"type": "boolean"
},
"addFiles": {
"type": "boolean"
},
"addForms": {
"type": "boolean"
},
"addLinks": {
"type": "boolean"
},
"addRisks": {
"type": "boolean"
},
"addTasks": {
"type": "boolean"
},
"viewTime": {
"type": "boolean"
},
"canAccess": {
"type": "boolean"
},
"viewLinks": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"setPrivacy": {
"type": "boolean"
},
"addExpenses": {
"type": "boolean"
},
"addMessages": {
"type": "boolean"
},
"isObserving": {
"type": "boolean"
},
"addNotebooks": {
"type": "boolean"
},
"addTaskLists": {
"type": "boolean"
},
"canViewForms": {
"type": "boolean"
},
"canViewRates": {
"type": "boolean"
},
"editAllTasks": {
"type": "boolean"
},
"viewInvoices": {
"type": "boolean"
},
"addMilestones": {
"type": "boolean"
},
"viewNotebooks": {
"type": "boolean"
},
"canManageRates": {
"type": "boolean"
},
"inOwnerCompany": {
"type": "boolean"
},
"canManagePeople": {
"type": "boolean"
},
"canViewSchedule": {
"type": "boolean"
},
"viewAllTimeLogs": {
"type": "boolean"
},
"addProjectUpdate": {
"type": "boolean"
},
"canEditWorkflows": {
"type": "boolean"
},
"canViewWorkflows": {
"type": "boolean"
},
"viewRiskRegister": {
"type": "boolean"
},
"canManageSchedule": {
"type": "boolean"
},
"viewEstimatedTime": {
"type": "boolean"
},
"viewProjectUpdate": {
"type": "boolean"
},
"manageCustomFields": {
"type": "boolean"
},
"canViewProjectBudget": {
"type": "boolean"
},
"projectAdministrator": {
"type": "boolean"
},
"viewMessagesAndFiles": {
"type": "boolean"
},
"canViewProjectMembers": {
"type": "boolean"
},
"canManageProjectBudget": {
"type": "boolean"
},
"viewTasksAndMilestones": {
"type": "boolean"
},
"canViewProjectTemplates": {
"type": "boolean"
},
"canManageProjectTemplates": {
"type": "boolean"
},
"receiveEmailNotifications": {
"type": "boolean"
},
"canManageProjectMembership": {
"type": "boolean"
}
},
"description": "ProjectPermissions determines the user permissions associated with a project."
}
view.ProjectUpdate
{
"type": "object",
"title": "ProjectUpdate",
"properties": {
"id": {
"type": "integer"
},
"text": {
"type": "string"
},
"color": {
"type": "string"
},
"health": {
"type": "integer"
},
"deleted": {
"type": "boolean"
},
"project": {
"$ref": "#/components/schemas/view.Relationship"
},
"isActive": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"type": "integer"
},
"projectId": {
"type": "integer"
},
"reactions": {
"$ref": "#/components/schemas/view.ReactionsForObject"
},
"updatedAt": {
"type": "string"
},
"healthLabel": {
"type": "string"
},
"likeFromUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"likeFromUserIDs": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "ProjectUpdate contains all the information returned from a update."
}
view.ProjectV205
{
"type": "object",
"title": "ProjectV205",
"properties": {
"id": {
"type": "integer"
},
"logo": {
"type": "string"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"type": {
"type": "string"
},
"endAt": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"status": {
"type": "string"
},
"tagIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"update": {
"$ref": "#/components/schemas/view.Relationship"
},
"company": {
"$ref": "#/components/schemas/view.Relationship"
},
"endDate": {
"type": "string"
},
"ownedBy": {
"type": "integer"
},
"ownerId": {
"type": "integer"
},
"startAt": {
"type": "string"
},
"category": {
"$ref": "#/components/schemas/view.Relationship"
},
"logoIcon": {
"type": "string"
},
"updateId": {
"type": "integer"
},
"companyId": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"type": "integer"
},
"isStarred": {
"type": "boolean"
},
"logoColor": {
"type": "string"
},
"startDate": {
"type": "string"
},
"startPage": {
"type": "string"
},
"subStatus": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"type": "integer"
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"categoryId": {
"type": "integer"
},
"isBillable": {
"type": "boolean"
},
"timeBudget": {
"$ref": "#/components/schemas/view.Relationship"
},
"activePages": {
"type": "object",
"properties": {
"list": {
"type": "boolean"
},
"time": {
"type": "boolean"
},
"board": {
"type": "boolean"
},
"files": {
"type": "boolean"
},
"forms": {
"type": "boolean"
},
"gantt": {
"type": "boolean"
},
"links": {
"type": "boolean"
},
"table": {
"type": "boolean"
},
"tasks": {
"type": "boolean"
},
"proofs": {
"type": "boolean"
},
"billing": {
"type": "boolean"
},
"finance": {
"type": "boolean"
},
"comments": {
"type": "boolean"
},
"messages": {
"type": "boolean"
},
"notebooks": {
"type": "boolean"
},
"milestones": {
"type": "boolean"
},
"riskRegister": {
"type": "boolean"
}
}
},
"description": {
"type": "string"
},
"announcement": {
"type": "string"
},
"integrations": {
"type": "object",
"properties": {
"xero": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"connected": {
"type": "boolean"
},
"countryCode": {
"type": "string"
},
"baseCurrency": {
"type": "string"
},
"organisation": {
"type": "string"
}
}
},
"sharepoint": {
"type": "object",
"properties": {
"folder": {
"type": "string"
},
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folderName": {
"type": "string"
}
}
},
"googleDrive": {
"type": "object",
"properties": {
"access": {
"type": "string"
},
"folder": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folderName": {
"type": "string"
}
}
},
"oneDriveBusiness": {
"type": "object",
"properties": {
"folder": {
"type": "string"
},
"account": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"folderName": {
"type": "string"
}
}
}
}
},
"lastWorkedOn": {
"type": "string"
},
"projectOwner": {
"$ref": "#/components/schemas/view.Relationship"
},
"skipWeekends": {
"type": "boolean"
},
"timeBudgetId": {
"type": "integer"
},
"defaultPrivacy": {
"type": "string"
},
"isProjectAdmin": {
"type": "boolean"
},
"latestActivity": {
"$ref": "#/components/schemas/view.Relationship"
},
"notifyEveryone": {
"type": "boolean"
},
"portfolioCards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"privacyEnabled": {
"type": "boolean"
},
"projectOwnerId": {
"type": "integer"
},
"tasksStartPage": {
"type": "string"
},
"financialBudget": {
"$ref": "#/components/schemas/view.Relationship"
},
"isSampleProject": {
"type": "boolean"
},
"showAnnouncement": {
"type": "boolean"
},
"allowNotifyAnyone": {
"type": "boolean"
},
"customFieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"customfieldValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"financialBudgetId": {
"type": "integer"
},
"overviewStartPage": {
"type": "string"
},
"notifyTaskAssignee": {
"type": "boolean"
},
"customFieldValueIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"isOnBoardingProject": {
"type": "boolean"
},
"replyByEmailEnabled": {
"type": "boolean"
},
"harvestTimersEnabled": {
"type": "boolean"
},
"minMaxAvailableDates": {
"$ref": "#/components/schemas/view.ProjectMinMaxAvailableDates"
},
"directFileUploadsEnabled": {
"type": "boolean"
},
"notifyCommentIncludeCreator": {
"type": "boolean"
}
},
"description": "ProjectV205 contains all the information returned from a project."
}
view.Proof
{
"type": "object",
"title": "Proof",
"properties": {
"id": {
"type": "integer"
},
"due": {
"$ref": "#/components/schemas/view.Date"
},
"state": {
"type": "string"
},
"title": {
"type": "string"
},
"entity": {
"$ref": "#/components/schemas/view.Relationship"
},
"parent": {
"$ref": "#/components/schemas/view.Relationship"
},
"status": {
"type": "string"
},
"company": {
"$ref": "#/components/schemas/view.Relationship"
},
"objects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.ProofObject"
}
},
"product": {
"type": "string"
},
"assignees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/view.Assignee"
}
},
"createdAt": {
"type": "string"
},
"createdBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"feedbackCount": {
"type": "integer"
},
"installationId": {
"$ref": "#/components/schemas/view.Relationship"
},
"errorObjectIdxs": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"description": "Proof contains all the information returned from a proof."
}
view.ProofObject
{
"type": "object",
"title": "ProofObject",
"properties": {
"id": {
"type": "integer"
},
"URL": {
"type": "string"
},
"due": {
"type": "string"
},
"size": {
"type": "integer"
},
"type": {
"type": "string"
},
"state": {
"type": "string"
},
"title": {
"type": "string"
},
"format": {
"type": "string"
},
"version": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"createdBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"deletedAt": {
"type": "string"
},
"deletedBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"thumbnail": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"$ref": "#/components/schemas/view.Relationship"
},
"totalChunks": {
"type": "integer"
},
"sourceFormat": {
"type": "string"
},
"stateMessage": {
"type": "string"
},
"approvalStatus": {
"type": "string"
},
"installationId": {
"$ref": "#/components/schemas/view.Relationship"
}
},
"description": "ProofObject is a proof object item type."
}