ProjectTemplatesGetRecordResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectTemplateBase"
}
}
}
ProjectTemplatesInstantiateProjectJobRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectTemplateInstantiateProjectRequest"
}
}
}
ProjectTemplatesInstantiateProjectJobResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JobCompact"
}
}
}
ProjectTemplatesListMultipleResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectTemplateCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
ProjectUpdateRequest
{
"allOf": [
{
"$ref": "#/components/schemas/ProjectBase"
},
{
"type": "object",
"properties": {
"team": {
"type": "string",
"example": "12345",
"description": "The team that this project is shared with."
},
"owner": {
"type": "string",
"example": "12345",
"nullable": true,
"description": "The current owner of the project, may be null."
},
"followers": {
"type": "string",
"example": 1234523456,
"description": "*Create-only*. Comma separated string of users. Followers are a subset of members who have opted in to receive \"tasks added\" notifications for a project."
},
"custom_fields": {
"type": "object",
"example": {
"4578152156": "Not Started",
"5678904321": "On Hold"
},
"description": "An object where each key is the GID of a custom field and its corresponding value is either an enum GID, string, number, or object (depending on the custom field type). See the [custom fields guide](https://raw.githubusercontent.com) for details on creating and updating custom field values.",
"additionalProperties": {
"type": "string",
"description": "\"{custom_field_gid}\" => Value (can be text, a number, etc.). For date, use format \"YYYY-MM-DD\" (e.g., 2019-09-15). For date-time, use ISO 8601 date string in UTC (e.g., 2019-09-15T02:06:58.147Z)."
}
}
}
}
]
}
ProjectsAddCustomFieldSettingRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AddCustomFieldSettingRequest"
}
}
}
ProjectsAddCustomFieldSettingResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CustomFieldSettingResponse"
}
}
}
ProjectsAddFollowersToProjectRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AddFollowersRequest"
}
}
}
ProjectsAddFollowersToProjectResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsAddMembersToProjectRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AddMembersRequest"
}
}
}
ProjectsAddMembersToProjectResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsCreateInWorkspaceRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequest"
}
}
}
ProjectsCreateInWorkspaceResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsCreateNewProjectRecordRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequest"
}
}
}
ProjectsCreateNewProjectRecordResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsCreateProjectForTeamRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectRequest"
}
}
}
ProjectsCreateProjectForTeamResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsCreateProjectTemplateJobRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectSaveAsTemplateRequest"
}
}
}
ProjectsCreateProjectTemplateJobResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JobCompact"
}
}
}
ProjectsDeleteProjectByIdResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
ProjectsDuplicateProjectJobRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectDuplicateRequest"
}
}
}
ProjectsDuplicateProjectJobResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JobCompact"
}
}
}
ProjectsGetAllInWorkspaceResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
ProjectsGetProjectRecordResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsGetTaskCountsResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaskCountResponse"
}
}
}
ProjectsGetTeamProjectsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
ProjectsListMultipleResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
ProjectsRemoveCustomFieldRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RemoveCustomFieldSettingRequest"
}
}
}
ProjectsRemoveCustomFieldResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}
ProjectsRemoveMembersFromProjectRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RemoveMembersRequest"
}
}
}
ProjectsRemoveMembersFromProjectResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsRemoveProjectFollowersRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RemoveFollowersRequest"
}
}
}
ProjectsRemoveProjectFollowersResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
ProjectsTaskProjectsListResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCompact"
}
},
"next_page": {
"$ref": "#/components/schemas/NextPage"
}
}
}
ProjectsUpdateProjectRecordRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectUpdateRequest"
}
}
}
ProjectsUpdateProjectRecordResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProjectResponse"
}
}
}
RemoveCustomFieldSettingRequest
{
"type": "object",
"required": [
"custom_field"
],
"properties": {
"custom_field": {
"type": "string",
"example": "14916",
"description": "The custom field to remove from this portfolio."
}
}
}
RemoveFollowersRequest
{
"type": "object",
"required": [
"followers"
],
"properties": {
"followers": {
"type": "string",
"example": 521621621373,
"description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user."
}
}
}
RemoveMembersRequest
{
"type": "object",
"required": [
"members"
],
"properties": {
"members": {
"type": "string",
"example": 521621621373,
"description": "An array of strings identifying users. These can either be the string \"me\", an email, or the gid of a user."
}
}
}
RequestedRoleRequest
{
"type": "object",
"properties": {
"gid": {
"type": "string",
"example": "1",
"description": "Globally unique identifier of the template role in the project template."
},
"value": {
"type": "string",
"example": "123",
"description": "The user id that should be assigned to the template role."
}
}
}
RuleTriggerRequest
{
"type": "object",
"required": [
"resource",
"action_data"
],
"properties": {
"resource": {
"type": "string",
"example": "12345",
"description": "The ID of the resource. For the duration of the beta, this resource is always a task, and this task must exist in the project in which the rule is created."
},
"action_data": {
"type": "object",
"example": {
"jira_ticket_id": "123",
"jira_ticket_name": "Test"
},
"description": "The dynamic keys and values of the request. These fields are intended to be used in the action for the rule associated with this trigger.",
"additionalProperties": true
}
}
}
RuleTriggerResponse
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Successfully saved the payload and ran the rule",
"description": "Message providing more detail about the result"
}
}
}
RulesTriggerRuleRequestRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RuleTriggerRequest"
}
}
}
RulesTriggerRuleRequestResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RuleTriggerResponse"
}
}
}
SectionCompact
{
"allOf": [
{
"$ref": "#/components/schemas/AsanaResource"
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Next Actions",
"description": "The name of the section (i.e. the text displayed as the section header)."
}
},
"description": "A *section* is a subdivision of a project that groups tasks together. It can either be a header above a list of tasks in a list view or a column in a board view of a project.",
"x-docs-overrides": {
"properties.resource_type.example": "section"
}
}
]
}
SectionRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "Next Actions",
"description": "The text to be displayed as the section name. This cannot be an empty string."
},
"insert_after": {
"type": "string",
"example": "987654",
"description": "An existing section within this project after which the added section should be inserted. Cannot be provided together with insert_before."
},
"insert_before": {
"type": "string",
"example": "86420",
"description": "An existing section within this project before which the added section should be inserted. Cannot be provided together with insert_after."
}
}
}
SectionResponse
{
"allOf": [
{
"$ref": "#/components/schemas/SectionCompact"
},
{
"type": "object",
"properties": {
"project": {
"$ref": "#/components/schemas/ProjectCompact"
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectCompact"
},
"readOnly": true,
"description": "*Deprecated - please use project instead*"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2012-02-22T02:06:58.147Z",
"readOnly": true,
"description": "The time at which this resource was created."
}
}
}
]
}
SectionTaskInsertRequest
{
"type": "object",
"required": [
"task"
],
"properties": {
"task": {
"type": "string",
"example": "123456",
"description": "The task to add to this section."
},
"insert_after": {
"type": "string",
"example": "987654",
"description": "An existing task within this section after which the added task should be inserted. Cannot be provided together with insert_before."
},
"insert_before": {
"type": "string",
"example": "86420",
"description": "An existing task within this section before which the added task should be inserted. Cannot be provided together with insert_after."
}
}
}
SectionsAddTaskToSectionRequest
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SectionTaskInsertRequest"
}
}
}
SectionsAddTaskToSectionResponse
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmptyResponse"
}
}
}