Asana: Status updates schemas
10 Asana schemas with complete fields and constraints.
← Status updates operations · All schemas
Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update resource subtype: project status update, portfolio status update, goal status update |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).text | string | Required within parent | The text content of the status update. |
$ (allOf 2).html_text | string | Optional | [Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text). |
$ (allOf 2).status_type | string | Required within parent | The type associated with the status update. This represents the current state of the object this object is on. The valid values for `status_type` depend on the parent of the status update: - Projects: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`. - Portfolios: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`. - Goals: `on_track`, `at_risk`, `off_track`, `achieved`, `partial`, `missed`, `dropped`. One of: on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped |
Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update resource subtype: project status update, portfolio status update, goal status update
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object. |
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 status update. |
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. The `resource_subtype`s for `status` objects represent the type of their parent. One of: project_status_update, portfolio_status_update, goal_status_update Read only: true |
Create a status update — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).parent | string | Required within parent | The id of parent to send this status update to. This can be a project, goal or portfolio. |
Referenced models: Create a status update — request body — body / data / resource_subtype: project status update, portfolio status update, goal status update
Get a status update — request body — query
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
opt_pretty | boolean | Optional | |
opt_fields | array | Optional | |
opt_fields[] | string | Each item | One of: author, author.name, created_at, created_by, created_by.name, hearted, hearts, hearts.user, hearts.user.name, html_text, liked, likes, likes.user, likes.user.name, modified_at, num_hearts, num_likes, parent, parent.name, parent.resource_subtype, reaction_summary, reaction_summary.count, reaction_summary.emoji_base, reaction_summary.reacted, reaction_summary.variant, resource_subtype, status_type, text, title |
Get a status update — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get a status update — response body — data data — sdk__Status Update Response |
Referenced models: Get a status update — response body — data data — sdk__Status Update Response
Get a status update — response body — data / data / resource_subtype: project status update, portfolio status update, goal status update
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get status updates from an object — response body — data, next page data item |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).text | string | Optional | The text content of the status update. |
$ (allOf 2).html_text | string | Optional | [Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text). |
$ (allOf 2).status_type | string | Optional | The type associated with the status update. This represents the current state of the object this object is on. The valid values for `status_type` depend on the parent of the status update: - Projects: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`. - Portfolios: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`. - Goals: `on_track`, `at_risk`, `off_track`, `achieved`, `partial`, `missed`, `dropped`. Known values: on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped |
Referenced models: Get status updates from an object — response body — data, next page data item
Get a status update — response body — data data — Status Update Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get a status update — response body — data / data / resource_subtype: project status update, portfolio status update, goal status update |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).author | Model | Optional | Expand Get users in a team — response body — data data item |
$ (allOf 2).created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
$ (allOf 2).created_by | Model | Optional | Expand Get users in a team — response body — data data item |
$ (allOf 2).hearted | boolean | Optional | *Deprecated - please use liked instead* True if the status is hearted by the authorized user, false if not. Read only: true |
$ (allOf 2).hearts | array | Optional | *Deprecated - please use likes instead* Array of likes for users who have hearted this status. Read only: true |
$ (allOf 2).hearts[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
$ (allOf 2).liked | boolean | Optional | True if the status is liked by the authorized user, false if not. |
$ (allOf 2).likes | array | Optional | Array of likes for users who have liked this status. Read only: true |
$ (allOf 2).likes[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item |
$ (allOf 2).reaction_summary | array | Optional | Summary of emoji reactions on this status. Read only: true |
$ (allOf 2).reaction_summary[] | Model | Each item | Expand Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system reaction summary item |
$ (allOf 2).modified_at | string | Optional | The time at which this project status was last modified. *Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the status.* Format: date-time Read only: true |
$ (allOf 2).num_hearts | JSON | Optional | |
$ (allOf 2).num_hearts (anyOf 1) | integer | Alternative | *Deprecated - please use likes instead* The number of users who have hearted this status. Read only: true |
$ (allOf 2).num_hearts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).num_likes | JSON | Optional | |
$ (allOf 2).num_likes (anyOf 1) | integer | Alternative | The number of users who have liked this status. Read only: true |
$ (allOf 2).num_likes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (allOf 2).parent | JSON | Optional | |
$ (allOf 2).parent (allOf 1) | Model | All variants apply | Expand Search projects in a workspace — response body — data data item |
$ (allOf 2).parent (allOf 2) | object | All variants apply | The parent of the status update. This can be a project, goal or portfolio, and indicates that this status was sent on that object. |
Referenced models: Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system likes item, Search projects in a workspace — response body — data data item, Get a story — response body — data / data / source: web, email, mobile, api, unknown, type: comment, system reaction summary item, Get a status update — response body — data / data / resource_subtype: project status update, portfolio status update, goal status update, Get users in a team — response body — data data item
Get a status update — response body — data data — sdk__Status Update 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 *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object. |
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 status update. |
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. The `resource_subtype`s for `status` objects represent the type of their parent. Known values: project_status_update, portfolio_status_update, goal_status_update Read only: true |
text | string | Optional | The text content of the status update. |
html_text | string | Optional | [Opt In](/docs/inputoutput-options). The text content of the status update with formatting as HTML. See [rich text](/docs/rich-text). |
status_type | string | Optional | The type associated with the status update. This represents the current state of the object this object is on. The valid values for `status_type` depend on the parent of the status update: - Projects: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`. - Portfolios: `on_track`, `at_risk`, `off_track`, `on_hold`, `complete`, `dropped`. - Goals: `on_track`, `at_risk`, `off_track`, `achieved`, `partial`, `missed`, `dropped`. Known values: on_track, at_risk, off_track, on_hold, complete, achieved, partial, missed, dropped |
author | Model | Optional | Expand Get an OOO entry — response body — data data user |
created_at | string | Optional | The time at which this resource was created. Format: date-time Read only: true |
created_by | Model | Optional | Expand Get an OOO entry — response body — data data user |
hearted | boolean | Optional | *Deprecated - please use liked instead* True if the status is hearted by the authorized user, false if not. Read only: true |
hearts | array | Optional | *Deprecated - please use likes instead* Array of likes for users who have hearted this status. Read only: true |
hearts[] | Model | Each item | Expand Get a goal — response body — data data likes item |
liked | boolean | Optional | True if the status is liked by the authorized user, false if not. |
likes | array | Optional | Array of likes for users who have liked this status. Read only: true |
likes[] | Model | Each item | Expand Get a goal — response body — data data likes item |
reaction_summary | array | Optional | Summary of emoji reactions on this status. Read only: true |
reaction_summary[] | Model | Each item | Expand Get a story — response body — data data reaction summary item |
modified_at | string | Optional | The time at which this project status was last modified. *Note: This does not currently reflect any changes in associations such as comments that may have been added or removed from the status.* Format: date-time Read only: true |
num_hearts | JSON | Optional | |
num_hearts (anyOf 1) | integer | Alternative | *Deprecated - please use likes instead* The number of users who have hearted this status. Read only: true |
num_hearts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
num_likes | JSON | Optional | |
num_likes (anyOf 1) | integer | Alternative | The number of users who have liked this status. Read only: true |
num_likes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
parent | 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 parent of the status update. This can be a project, goal or portfolio, and indicates that this status was sent on that object. |
parent.gid | string | Optional | Globally unique identifier of the resource, as a string. Read only: true |
parent.resource_type | string | Optional | The base type of this resource. Read only: true |
parent.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. |
parent.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 |
Referenced models: Get an OOO entry — response body — data data user, Get a goal — response body — data data likes item, Get a story — response body — data data reaction summary item
Get status updates from an object — response body — data, next page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get a status update — response body — data data — sdk__Status Update Response |
next_page | Model | Optional | Expand Get goals — response body — data, next page next page |
Referenced models: Get goals — response body — data, next page next page, Get a status update — response body — data data — sdk__Status Update Response
Get status updates from an object — response body — data, next page data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A *status update* is an update on the progress of a particular project, portfolio, or goal, and is sent out to all of its parent's followers when created. These updates include both text describing the update and a `status_type` intended to represent the overall state of the object. |
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 status update. |
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. The `resource_subtype`s for `status` objects represent the type of their parent. Known values: project_status_update, portfolio_status_update, goal_status_update Read only: true |