Asana: Project briefs schemas
6 Asana schemas with complete fields and constraints.
← Project briefs operations · All schemas
Create a project brief — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a project brief — response body — data data gid, html text, resource type, title |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).text | string | Optional | The plain text of the project brief. When writing to a project brief, you can specify either `html_text` (preferred) or `text`, but not both. |
Referenced models: Get a project brief — response body — data data gid, html text, resource type, title
Get a project brief — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a project brief — response body — data data — sdk__Project Brief Response |
Referenced models: Get a project brief — response body — data data — sdk__Project Brief Response
Get a project brief — response body — data data gid, html text, resource type, title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a project brief — response body — data data gid, html text, resource type, title gid, resource type |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).title | string | Optional | The title of the project brief. |
$ (allOf 2).html_text | string | Optional | HTML formatted text for the project brief. See [rich text](/docs/rich-text). |
Referenced models: Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *Project Brief* allows you to explain the what and why of the project to your team. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
Get a project brief — response body — data data — Project Brief Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a project brief — response body — data data gid, html text, resource type, title |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).text | string | Optional | [Opt In](/docs/inputoutput-options). The plain text of the project brief. |
$ (allOf 2).permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
$ (allOf 2).project | JSON | Optional | |
$ (allOf 2).project (allOf 1) | Model | All variants apply | Expand Search projects in a workspace — response body — data data item |
$ (allOf 2).project (allOf 2) | object | All variants apply | The project with which this project brief is associated. |
Referenced models: Get a project brief — response body — data data gid, html text, resource type, title, Search projects in a workspace — response body — data data item
Get a project brief — response body — data data — sdk__Project Brief Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *Project Brief* allows you to explain the what and why of the project to your team. |
gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
resource_type | string | Optional | The base type of this resource. Read only: true |
title | string | Optional | The title of the project brief. |
html_text | string | Optional | HTML formatted text for the project brief. See [rich text](/docs/rich-text). |
text | string | Optional | [Opt In](/docs/inputoutput-options). The plain text of the project brief. |
permalink_url | string | Optional | A url that points directly to the object within Asana. Read only: true |
project | object | Optional | A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier. A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions. The project with which this project brief is associated. |
project.gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
project.resource_type | string | Optional | The base type of this resource. Read only: true |
project.name | string | Optional | Name of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. |
project.resource_subtype | string | Optional | The subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning. Known values: default_project, custom |