Asana · Schema

PortfolioResponse

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow
View JSON Schema on GitHub

JSON Schema

asana-portfolioresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PortfolioResponse",
  "title": "PortfolioResponse",
  "allOf": [
    {
      "$ref": "#/components/schemas/PortfolioBase"
    },
    {
      "type": "object",
      "properties": {
        "created_at": {
          "description": "The time at which this resource was created.",
          "type": "string",
          "format": "date-time",
          "readOnly": true,
          "example": "2012-02-22T02:06:58.147Z"
        },
        "created_by": {
          "$ref": "#/components/schemas/UserCompact"
        },
        "custom_field_settings": {
          "description": "Array of custom field settings applied to the portfolio.",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CustomFieldSettingResponse"
          }
        },
        "current_status_update": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StatusUpdateCompact"
            },
            {
              "description": "The latest `status_update` posted to this portfolio.",
              "nullable": true
            }
          ]
        },
        "due_on": {
          "description": "The localized day on which this portfolio is due. This takes a date with format YYYY-MM-DD.",
          "type": "string",
          "format": "date",
          "nullable": true,
          "example": "2019-09-15"
        },
        "custom_fields": {
          "description": "Array of Custom Fields.",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CustomFieldCompact"
          }
        },
        "members": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/components/schemas/UserCompact"
          }
        },
        "owner": {
          "$ref": "#/components/schemas/UserCompact"
        },
        "start_on": {
          "description": "The day on which work for this portfolio begins, or null if the portfolio has no start date. This takes a date with `YYYY-MM-DD` format. *Note: `due_on` must be present in the request when setting or unsetting the `start_on` parameter. Additionally, `start_on` and `due_on` cannot be the same date.*",
          "type": "string",
          "format": "date",
          "nullable": true,
          "example": "2019-09-14"
        },
        "workspace": {
          "allOf": [
            {
              "$ref": "#/components/schemas/WorkspaceCompact"
            },
            {
              "type": "object",
              "description": "*Create-only*. The workspace or organization that the portfolio belongs to."
            }
          ]
        },
        "permalink_url": {
          "type": "string",
          "readOnly": true,
          "description": "A url that points directly to the object within Asana.",
          "example": "https://app.asana.com/0/resource/123456789/list"
        },
        "public": {
          "description": "True if the portfolio is public to its workspace members.",
          "type": "boolean",
          "example": false
        },
        "default_access_level": {
          "description": "The default access level when inviting new members to the portfolio",
          "type": "string",
          "enum": [
            "admin",
            "editor",
            "viewer"
          ],
          "example": "viewer"
        },
        "privacy_setting": {
          "description": "The privacy setting of the portfolio. *Note: Administrators in your organization may restrict the values of `privacy_setting`.*",
          "type": "string",
          "enum": [
            "public_to_domain",
            "members_only"
          ],
          "example": "members_only"
        },
        "project_templates": {
          "description": "Array of project templates that are in the portfolio",
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/components/schemas/ProjectTemplateCompact"
          }
        }
      }
    }
  ]
}