{ "openapi": "3.1.0", "info": { "title": "Aha! API v3", "version": "3.0", "description": "JSON REST API for the Aha! product development platform.\n\n# Authentication\n\nAuthenticate with an API key or OAuth2 access token in the `Authorization` header:\n\n```http\nAuthorization: Bearer \n```\n\nGenerate an API key in **Settings > Personal > Developer > API key**.\nSee the [API key documentation](https://www.aha.io/api#api-key) for details.\n\nTo authorize an application to access Aha! on a user's behalf, register your application\nand follow the [OAuth2 authorization flow](https://www.aha.io/api/oauth2).\n\nRequests use the permissions of the user associated with the key or token, who must have\naccess to the account identified by the URL's subdomain.\n\n# Fields\n\nResponses include a small set of default fields when `fields` is omitted.\nPass a comma-separated `fields` query parameter to return only the fields you need:\n`/api/v3/features/PROJ-1?fields=id,name,status`. Include `default` to keep the default\nfields and add others, for example `fields=default,assigned_to_user`.\n\nSelect fields within an associated record or collection using dot notation or bracket\nshorthand. For example, `fields=id,status.id,status.name` and\n`fields=id,status[id,name]` are equivalent. The same syntax works for collections, such as\n`fields=id,requirements[id,name]`. Use `default` within brackets to include the associated\nresource's defaults plus other fields: `requirements[default,assigned_to_user]`.\n\nCollections can only be selected on the top-level resource. Selecting a collection on a\nnested resource, such as `fields=feature[requirements]` or `fields=feature[tags]`, returns\na `fields.nested_collection` error. Unknown fields return a `fields.unknown` error.\n\nCustom fields are omitted unless requested. Select individual custom fields by API key with\n`fields=default,custom_fields.priority` or `fields=default,custom_fields[priority,effort]`.\nRequest bare `custom_fields` to return all supported custom fields.\n\nCreate and update responses honor `fields` and also include fields submitted in the\n`record` body. Submitted association IDs return the corresponding embedded association,\nand submitted custom field keys are returned without separately requesting them in `fields`.\n\n# Filtering\n\nUse `filter.{operator}[{field}]=value` query parameters on list endpoints.\nMultiple filters combine with AND logic. Each endpoint lists its filterable fields\nand the operators supported for each field type.\n\nFor example, `/api/v3/features?filter.contains[name]=login&filter.eq[status.name]=In%20progress`\nreturns features whose names contain \"login\" and whose status is \"In progress\".\n\nUse comma-separated values for `in` and `not_in`, and two comma-separated bounds for\n`between` (inclusive). Pass `true` for `empty` and `not_empty`.\nFields with a fixed set of choices accept their documented labels.\n\n### Sub-attribute filtering\n\nFilter on attributes of associated records using dot notation:\n`filter.{operator}[field.attribute]=value`.\nFor example, `filter.eq[status.name]=In%20progress` or `filter.in[tags.name]=Backend,API`.\n\nSupported operators depend on the subfield's type and filterability. Compare associated\nrecords using subfields such as `status.id` or `status.name`. Bare associations support\nemptiness checks, not equality comparisons.\n\n### Custom field filtering\n\nUse the custom field's API key: `filter.{operator}[custom_fields.{key}]=value`.\nText, URL, number, date, and checkbox custom fields support operators for their\ncorresponding field type. Other custom field types are not supported.\n\n# Pagination\n\nList endpoints return `records` and a `pagination` object. Use `per_page` to set the\npage size (default 25,\nmaximum 200).\n\nWhen `pagination.has_more` is `true`, follow `pagination.next_url` or pass\n`pagination.next_cursor` as the `after` query parameter with the same filters and sort.\nTreat cursors as opaque values. When `has_more` is `false`, `next_cursor` and `next_url` are `null`.\n\n### Default order and retrieving all records\n\nWithout a sort parameter, records are returned by ID in descending order.\nThis mode supports pagination through all matching records without a total record limit.\n\n### Sorting and the record limit\n\nUse `sort.asc={field}` or `sort.desc={field}` to sort by a field listed by the endpoint.\nSupplying either parameter, including an explicit sort by ID, limits results to the first\n1,000 records across all pages.\n\nIf more records exist beyond this limit, the final page has `pagination.truncated: true`,\nan explanatory `pagination.truncated_message`, and `pagination.has_more: false`.\nAttempting to paginate beyond the limit returns `pagination.max_records_exceeded`.\n\nTo retrieve all matching records, remove `sort.asc` and `sort.desc` and restart without\nan `after` cursor. Then follow the pagination links in the default descending ID order." }, "servers": [ { "url": "https://{subdomain}.aha.io", "variables": { "subdomain": { "default": "yourcompany", "description": "Your Aha! account subdomain" } } } ], "security": [ { "bearerAuth": [] } ], "paths": { "/api/v3/goals": { "get": { "tags": [ "Goals" ], "summary": "List goals", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listGoals", "x-aha-field-schema": "Goal", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "position", "color", "effort", "value", "progress" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "position", "color", "effort", "value", "progress" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" }, "progress_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" }, "progress_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" }, "progress_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" }, "progress_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" }, "progress_source": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "time_frame": { "type": "string" }, "project": { "type": "string" }, "features": { "type": "string" }, "epics": { "type": "string" }, "initiatives": { "type": "string" }, "rollup_goals": { "type": "string" }, "children": { "type": "string" }, "key_results": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" }, "progress_source": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "time_frame": { "type": "string" }, "project": { "type": "string" }, "features": { "type": "string" }, "epics": { "type": "string" }, "initiatives": { "type": "string" }, "rollup_goals": { "type": "string" }, "children": { "type": "string" }, "key_results": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "position": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of goals", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Goal" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Goals" ], "summary": "Create goal", "operationId": "createGoal", "x-aha-field-schema": "Goal", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoalCreateInput" } } } }, "responses": { "201": { "description": "The created goal", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Goal" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/goals/{id}": { "get": { "tags": [ "Goals" ], "summary": "Get goal", "operationId": "getGoal", "x-aha-field-schema": "Goal", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the goal", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single goal", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Goal" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Goals" ], "summary": "Update goal", "operationId": "updateGoal", "x-aha-field-schema": "Goal", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the goal", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoalUpdateInput" } } } }, "responses": { "200": { "description": "The updated goal", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Goal" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Goals" ], "summary": "Update goal", "operationId": "patchGoal", "x-aha-field-schema": "Goal", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the goal", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoalUpdateInput" } } } }, "responses": { "200": { "description": "The updated goal", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Goal" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Goals" ], "summary": "Delete goal", "operationId": "deleteGoal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the goal", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/initiatives": { "get": { "tags": [ "Initiatives" ], "summary": "List initiatives", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listInitiatives", "x-aha-field-schema": "Initiative", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "position", "progress", "score", "color", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done", "effort", "value" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "position", "progress", "score", "color", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done", "effort", "value" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "time_frame": { "type": "string" }, "description": { "type": "string" }, "time_code": { "type": "string" }, "parent": { "type": "string" }, "project": { "type": "string" }, "goals": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "time_frame": { "type": "string" }, "description": { "type": "string" }, "time_code": { "type": "string" }, "parent": { "type": "string" }, "project": { "type": "string" }, "goals": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "effort": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of initiatives", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Initiative" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Initiatives" ], "summary": "Create initiative", "operationId": "createInitiative", "x-aha-field-schema": "Initiative", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiativeCreateInput" } } } }, "responses": { "201": { "description": "The created initiative", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Initiative" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/initiatives/{id}": { "get": { "tags": [ "Initiatives" ], "summary": "Get initiative", "operationId": "getInitiative", "x-aha-field-schema": "Initiative", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the initiative", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single initiative", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Initiative" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Initiatives" ], "summary": "Update initiative", "operationId": "updateInitiative", "x-aha-field-schema": "Initiative", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the initiative", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiativeUpdateInput" } } } }, "responses": { "200": { "description": "The updated initiative", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Initiative" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Initiatives" ], "summary": "Update initiative", "operationId": "patchInitiative", "x-aha-field-schema": "Initiative", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the initiative", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiativeUpdateInput" } } } }, "responses": { "200": { "description": "The updated initiative", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Initiative" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Initiatives" ], "summary": "Delete initiative", "operationId": "deleteInitiative", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the initiative", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/competitors": { "get": { "tags": [ "Competitors" ], "summary": "List competitors", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listCompetitors", "x-aha-field-schema": "Competitor", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "color", "subtitle", "website" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "color", "subtitle", "website" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" }, "project": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "subtitle": { "type": "string" }, "website": { "type": "string" }, "project": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of competitors", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Competitor" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Competitors" ], "summary": "Create competitor", "operationId": "createCompetitor", "x-aha-field-schema": "Competitor", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorCreateInput" } } } }, "responses": { "201": { "description": "The created competitor", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Competitor" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/competitors/{id}": { "get": { "tags": [ "Competitors" ], "summary": "Get competitor", "operationId": "getCompetitor", "x-aha-field-schema": "Competitor", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the competitor", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single competitor", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Competitor" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Competitors" ], "summary": "Update competitor", "operationId": "updateCompetitor", "x-aha-field-schema": "Competitor", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the competitor", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorUpdateInput" } } } }, "responses": { "200": { "description": "The updated competitor", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Competitor" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Competitors" ], "summary": "Update competitor", "operationId": "patchCompetitor", "x-aha-field-schema": "Competitor", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the competitor", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompetitorUpdateInput" } } } }, "responses": { "200": { "description": "The updated competitor", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Competitor" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Competitors" ], "summary": "Delete competitor", "operationId": "deleteCompetitor", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the competitor", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/personas": { "get": { "tags": [ "Personas" ], "summary": "List personas", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listPersonas", "x-aha-field-schema": "Persona", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "color", "occupation", "quote" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "color", "occupation", "quote" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" }, "project": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "occupation": { "type": "string" }, "quote": { "type": "string" }, "project": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of personas", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Persona" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Personas" ], "summary": "Create persona", "operationId": "createPersona", "x-aha-field-schema": "Persona", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaCreateInput" } } } }, "responses": { "201": { "description": "The created persona", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Persona" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/personas/{id}": { "get": { "tags": [ "Personas" ], "summary": "Get persona", "operationId": "getPersona", "x-aha-field-schema": "Persona", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the persona", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single persona", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Persona" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Personas" ], "summary": "Update persona", "operationId": "updatePersona", "x-aha-field-schema": "Persona", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the persona", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaUpdateInput" } } } }, "responses": { "200": { "description": "The updated persona", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Persona" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Personas" ], "summary": "Update persona", "operationId": "patchPersona", "x-aha-field-schema": "Persona", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the persona", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonaUpdateInput" } } } }, "responses": { "200": { "description": "The updated persona", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Persona" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Personas" ], "summary": "Delete persona", "operationId": "deletePersona", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the persona", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/tags": { "get": { "tags": [ "Tags" ], "summary": "List tags", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listTags", "x-aha-field-schema": "Tag", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "type" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "type" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of tags", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Tags" ], "summary": "Create tag", "operationId": "createTag", "x-aha-field-schema": "Tag", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreateInput" } } } }, "responses": { "201": { "description": "The created tag", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Tag" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/tags/{id}": { "get": { "tags": [ "Tags" ], "summary": "Get tag", "operationId": "getTag", "x-aha-field-schema": "Tag", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the tag", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single tag", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Tag" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Tags" ], "summary": "Update tag", "operationId": "updateTag", "x-aha-field-schema": "Tag", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the tag", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdateInput" } } } }, "responses": { "200": { "description": "The updated tag", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Tag" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Tags" ], "summary": "Update tag", "operationId": "patchTag", "x-aha-field-schema": "Tag", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the tag", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdateInput" } } } }, "responses": { "200": { "description": "The updated tag", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Tag" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Tags" ], "summary": "Delete tag", "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the tag", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/annotations": { "get": { "tags": [ "Annotations" ], "summary": "List annotations", "description": "Requires owner_type (interview or file) and owner_id. Returns annotations on Discovery interview transcripts or Discovery file content. Other owner types are not yet supported.\nSee [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listAnnotations", "x-aha-field-schema": "Annotation", "x-aha-field-mode": "list", "x-aha-description": "Requires owner_type (interview or file) and owner_id. Returns annotations on Discovery interview transcripts or Discovery file content. Other owner types are not yet supported.", "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "type", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "type", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of annotations", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Annotation" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/annotations/{id}": { "get": { "tags": [ "Annotations" ], "summary": "Get annotation", "operationId": "getAnnotation", "x-aha-field-schema": "Annotation", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the annotation", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single annotation", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Annotation" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/iterations": { "get": { "tags": [ "Iterations" ], "summary": "List iterations", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listIterations", "x-aha-field-schema": "Iteration", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "status", "start_date", "duration", "goal", "progress" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "status", "start_date", "duration", "goal", "progress" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "goal": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "string" }, "goal": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "goal": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "goal": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "string" }, "goal": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" }, "duration": { "type": "string" }, "goal": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "goal": { "type": "string" }, "progress": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "features": { "type": "string" }, "requirements": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "goal": { "type": "string" }, "progress": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "features": { "type": "string" }, "requirements": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "duration": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of iterations", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Iteration" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Iterations" ], "summary": "Create iteration", "operationId": "createIteration", "x-aha-field-schema": "Iteration", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IterationCreateInput" } } } }, "responses": { "201": { "description": "The created iteration", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Iteration" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/iterations/{id}": { "get": { "tags": [ "Iterations" ], "summary": "Get iteration", "operationId": "getIteration", "x-aha-field-schema": "Iteration", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the iteration", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single iteration", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Iteration" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Iterations" ], "summary": "Update iteration", "operationId": "updateIteration", "x-aha-field-schema": "Iteration", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the iteration", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IterationUpdateInput" } } } }, "responses": { "200": { "description": "The updated iteration", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Iteration" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Iterations" ], "summary": "Update iteration", "operationId": "patchIteration", "x-aha-field-schema": "Iteration", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the iteration", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IterationUpdateInput" } } } }, "responses": { "200": { "description": "The updated iteration", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Iteration" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Iterations" ], "summary": "Delete iteration", "operationId": "deleteIteration", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the iteration", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/program_increments": { "get": { "tags": [ "Program increments" ], "summary": "List program increments", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listProgramIncrements", "x-aha-field-schema": "ProgramIncrement", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "start_date", "end_date", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "start_date", "end_date", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "owner": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "status": { "type": "string" }, "owner": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of program increments", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramIncrement" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/program_increments/{id}": { "get": { "tags": [ "Program increments" ], "summary": "Get program increment", "operationId": "getProgramIncrement", "x-aha-field-schema": "ProgramIncrement", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the program increment", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single program increment", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/ProgramIncrement" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/key_results": { "get": { "tags": [ "Key results" ], "summary": "List key results", "description": "Key results are only available for accounts on the Enterprise+ plans.\n\nSee [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listKeyResults", "x-aha-field-schema": "KeyResult", "x-aha-field-mode": "list", "x-aha-description": "Key results are only available for accounts on the Enterprise+ plans.\n", "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "reference_num", "name", "position", "progress", "target_metric", "starting_metric", "current_metric", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "reference_num", "name", "position", "progress", "target_metric", "starting_metric", "current_metric", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "description": { "type": "string" }, "goal": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "target_metric": { "type": "string" }, "starting_metric": { "type": "string" }, "current_metric": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "description": { "type": "string" }, "goal": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of key results", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResult" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Key results" ], "summary": "Create key result", "operationId": "createKeyResult", "x-aha-field-schema": "KeyResult", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyResultCreateInput" } } } }, "responses": { "201": { "description": "The created key result", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/KeyResult" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/key_results/{id}": { "get": { "tags": [ "Key results" ], "summary": "Get key result", "operationId": "getKeyResult", "x-aha-field-schema": "KeyResult", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the key result", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single key result", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/KeyResult" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Key results" ], "summary": "Update key result", "operationId": "updateKeyResult", "x-aha-field-schema": "KeyResult", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the key result", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyResultUpdateInput" } } } }, "responses": { "200": { "description": "The updated key result", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/KeyResult" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Key results" ], "summary": "Update key result", "operationId": "patchKeyResult", "x-aha-field-schema": "KeyResult", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the key result", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyResultUpdateInput" } } } }, "responses": { "200": { "description": "The updated key result", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/KeyResult" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Key results" ], "summary": "Delete key result", "operationId": "deleteKeyResult", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the key result", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/strategy_models": { "get": { "tags": [ "Strategic models" ], "summary": "List strategic models", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listStrategyModels", "x-aha-field-schema": "StrategyModel", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "reference_num", "name", "position", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "reference_num", "name", "position", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "time_frame": { "type": "string" }, "description": { "type": "string" }, "watchers": { "type": "string" }, "components": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "time_frame": { "type": "string" }, "description": { "type": "string" }, "watchers": { "type": "string" }, "components": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of strategic models", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/StrategyModel" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/strategy_models/{id}": { "get": { "tags": [ "Strategic models" ], "summary": "Get strategic model", "operationId": "getStrategyModel", "x-aha-field-schema": "StrategyModel", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the strategic model", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single strategic model", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/StrategyModel" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/strategy_visions": { "get": { "tags": [ "Strategy visions" ], "summary": "List strategy visions", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listStrategyVisions", "x-aha-field-schema": "StrategyVision", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "description": { "type": "string" }, "components": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "description": { "type": "string" }, "components": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of strategy visions", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/StrategyVision" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/strategy_visions/{id}": { "get": { "tags": [ "Strategy visions" ], "summary": "Get strategy vision", "operationId": "getStrategyVision", "x-aha-field-schema": "StrategyVision", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the strategy vision", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single strategy vision", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/StrategyVision" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/strategy_vision_components": { "get": { "tags": [ "Strategy vision components" ], "summary": "List strategy vision components", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listStrategyVisionComponents", "x-aha-field-schema": "StrategyVisionComponent", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "title", "position" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "title", "position" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "title": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "title": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "position": { "type": "string" }, "description": { "type": "string" }, "strategy_vision": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "position": { "type": "string" }, "description": { "type": "string" }, "strategy_vision": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of strategy vision components", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/StrategyVisionComponent" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/strategy_vision_components/{id}": { "get": { "tags": [ "Strategy vision components" ], "summary": "Get strategy vision component", "operationId": "getStrategyVisionComponent", "x-aha-field-schema": "StrategyVisionComponent", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the strategy vision component", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single strategy vision component", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/StrategyVisionComponent" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/strategy_positions": { "get": { "tags": [ "Positioning" ], "summary": "List positioning", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listStrategyPositions", "x-aha-field-schema": "StrategyPosition", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "reference_num", "name", "position", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "reference_num", "name", "position", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "time_frame": { "type": "string" }, "description": { "type": "string" }, "watchers": { "type": "string" }, "components": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "time_frame": { "type": "string" }, "description": { "type": "string" }, "watchers": { "type": "string" }, "components": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of positioning", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/StrategyPosition" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/strategy_positions/{id}": { "get": { "tags": [ "Positioning" ], "summary": "Get positioning", "operationId": "getStrategyPosition", "x-aha-field-schema": "StrategyPosition", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the positioning", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single positioning", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/StrategyPosition" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/business_model_components": { "get": { "tags": [ "Business model components" ], "summary": "List business model components", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listBusinessModelComponents", "x-aha-field-schema": "BusinessModelComponent", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "position" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "position" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "description": { "type": "string" }, "business_model": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" }, "description": { "type": "string" }, "business_model": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of business model components", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessModelComponent" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/business_model_components/{id}": { "get": { "tags": [ "Business model components" ], "summary": "Get business model component", "operationId": "getBusinessModelComponent", "x-aha-field-schema": "BusinessModelComponent", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the business model component", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single business model component", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/BusinessModelComponent" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/releases": { "get": { "tags": [ "Releases" ], "summary": "List releases", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listReleases", "x-aha-field-schema": "Release", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "type", "created_at", "updated_at", "start_date", "end_date", "release_date", "released_on", "development_started_on", "external_release_date", "external_date_resolution", "parking_lot", "position", "progress" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "type", "created_at", "updated_at", "start_date", "end_date", "release_date", "released_on", "development_started_on", "external_release_date", "external_date_resolution", "parking_lot", "position", "progress" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "external_date_resolution": { "type": "string" }, "parking_lot": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "external_date_resolution": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "external_date_resolution": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "external_date_resolution": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "external_date_resolution": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "status": { "type": "string" }, "owner": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "parent": { "type": "string" }, "features": { "type": "string" }, "release_phases": { "type": "string" }, "children": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "external_date_resolution": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "status": { "type": "string" }, "owner": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "parent": { "type": "string" }, "features": { "type": "string" }, "release_phases": { "type": "string" }, "children": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "release_date": { "type": "string" }, "released_on": { "type": "string" }, "development_started_on": { "type": "string" }, "external_release_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of releases", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Release" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Releases" ], "summary": "Create release", "operationId": "createRelease", "x-aha-field-schema": "Release", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseCreateInput" } } } }, "responses": { "201": { "description": "The created release", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Release" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/releases/{id}": { "get": { "tags": [ "Releases" ], "summary": "Get release", "operationId": "getRelease", "x-aha-field-schema": "Release", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single release", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Release" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Releases" ], "summary": "Update release", "operationId": "updateRelease", "x-aha-field-schema": "Release", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseUpdateInput" } } } }, "responses": { "200": { "description": "The updated release", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Release" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Releases" ], "summary": "Update release", "operationId": "patchRelease", "x-aha-field-schema": "Release", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseUpdateInput" } } } }, "responses": { "200": { "description": "The updated release", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Release" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Releases" ], "summary": "Delete release", "operationId": "deleteRelease", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/release_phases": { "get": { "tags": [ "Release phases" ], "summary": "List release phases", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listReleasePhases", "x-aha-field-schema": "ReleasePhase", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "type", "position", "color", "progress" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "type", "position", "color", "progress" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "description": { "type": "string" }, "release": { "type": "string" }, "features": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "progress": { "type": "string" }, "description": { "type": "string" }, "release": { "type": "string" }, "features": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "progress": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of release phases", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ReleasePhase" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Release phases" ], "summary": "Create release phase", "operationId": "createReleasePhase", "x-aha-field-schema": "ReleasePhase", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePhaseCreateInput" } } } }, "responses": { "201": { "description": "The created release phase", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/ReleasePhase" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/release_phases/{id}": { "get": { "tags": [ "Release phases" ], "summary": "Get release phase", "operationId": "getReleasePhase", "x-aha-field-schema": "ReleasePhase", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release phase", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single release phase", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/ReleasePhase" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Release phases" ], "summary": "Update release phase", "operationId": "updateReleasePhase", "x-aha-field-schema": "ReleasePhase", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release phase", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePhaseUpdateInput" } } } }, "responses": { "200": { "description": "The updated release phase", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/ReleasePhase" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Release phases" ], "summary": "Update release phase", "operationId": "patchReleasePhase", "x-aha-field-schema": "ReleasePhase", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release phase", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePhaseUpdateInput" } } } }, "responses": { "200": { "description": "The updated release phase", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/ReleasePhase" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Release phases" ], "summary": "Delete release phase", "operationId": "deleteReleasePhase", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the release phase", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/features": { "get": { "tags": [ "Features" ], "summary": "List features", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listFeatures", "x-aha-field-schema": "Feature", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "progress", "score", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done", "position", "estimate_source" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "progress", "score", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done", "position", "estimate_source" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" }, "epic": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "assigned_to_user": { "type": "string" }, "created_by_user": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "release": { "type": "string" }, "release_phase": { "type": "string" }, "iteration": { "type": "string" }, "initiative": { "type": "string" }, "team": { "type": "string" }, "team_status": { "type": "string" }, "program_increment": { "type": "string" }, "time_code": { "type": "string" }, "tags": { "type": "string" }, "requirements": { "type": "string" }, "goals": { "type": "string" }, "key_results": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" }, "epic": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "assigned_to_user": { "type": "string" }, "created_by_user": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "release": { "type": "string" }, "release_phase": { "type": "string" }, "iteration": { "type": "string" }, "initiative": { "type": "string" }, "team": { "type": "string" }, "team_status": { "type": "string" }, "program_increment": { "type": "string" }, "time_code": { "type": "string" }, "tags": { "type": "string" }, "requirements": { "type": "string" }, "goals": { "type": "string" }, "key_results": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of features", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Features" ], "summary": "Create feature", "operationId": "createFeature", "x-aha-field-schema": "Feature", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureCreateInput" } } } }, "responses": { "201": { "description": "The created feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Feature" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/features/{id}": { "get": { "tags": [ "Features" ], "summary": "Get feature", "operationId": "getFeature", "x-aha-field-schema": "Feature", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the feature", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Feature" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Features" ], "summary": "Update feature", "operationId": "updateFeature", "x-aha-field-schema": "Feature", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the feature", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureUpdateInput" } } } }, "responses": { "200": { "description": "The updated feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Feature" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Features" ], "summary": "Update feature", "operationId": "patchFeature", "x-aha-field-schema": "Feature", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the feature", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureUpdateInput" } } } }, "responses": { "200": { "description": "The updated feature", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Feature" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Features" ], "summary": "Delete feature", "operationId": "deleteFeature", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the feature", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/epics": { "get": { "tags": [ "Epics" ], "summary": "List epics", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listEpics", "x-aha-field-schema": "Epic", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "progress", "score", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done", "position", "estimate_source" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "progress", "score", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done", "position", "estimate_source" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "created_by_user": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "release": { "type": "string" }, "release_phase": { "type": "string" }, "iteration": { "type": "string" }, "initiative": { "type": "string" }, "team": { "type": "string" }, "team_status": { "type": "string" }, "program_increment": { "type": "string" }, "time_code": { "type": "string" }, "tags": { "type": "string" }, "features": { "type": "string" }, "goals": { "type": "string" }, "key_results": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" }, "progress_source": { "type": "string" }, "estimate_source": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "created_by_user": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "release": { "type": "string" }, "release_phase": { "type": "string" }, "iteration": { "type": "string" }, "initiative": { "type": "string" }, "team": { "type": "string" }, "team_status": { "type": "string" }, "program_increment": { "type": "string" }, "time_code": { "type": "string" }, "tags": { "type": "string" }, "features": { "type": "string" }, "goals": { "type": "string" }, "key_results": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "progress": { "type": "string" }, "score": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of epics", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Epic" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Epics" ], "summary": "Create epic", "operationId": "createEpic", "x-aha-field-schema": "Epic", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpicCreateInput" } } } }, "responses": { "201": { "description": "The created epic", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Epic" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/epics/{id}": { "get": { "tags": [ "Epics" ], "summary": "Get epic", "operationId": "getEpic", "x-aha-field-schema": "Epic", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the epic", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single epic", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Epic" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Epics" ], "summary": "Update epic", "operationId": "updateEpic", "x-aha-field-schema": "Epic", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the epic", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpicUpdateInput" } } } }, "responses": { "200": { "description": "The updated epic", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Epic" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Epics" ], "summary": "Update epic", "operationId": "patchEpic", "x-aha-field-schema": "Epic", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the epic", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EpicUpdateInput" } } } }, "responses": { "200": { "description": "The updated epic", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Epic" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Epics" ], "summary": "Delete epic", "operationId": "deleteEpic", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the epic", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/requirements": { "get": { "tags": [ "Requirements" ], "summary": "List requirements", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listRequirements", "x-aha-field-schema": "Requirement", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "position", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "position", "initial_estimate", "detailed_estimate", "remaining_estimate", "work_done" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "description": { "type": "string" }, "feature": { "type": "string" }, "iteration": { "type": "string" }, "created_by_user": { "type": "string" }, "team": { "type": "string" }, "team_status": { "type": "string" }, "program_increment": { "type": "string" }, "time_code": { "type": "string" }, "tags": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" }, "status": { "type": "string" }, "assigned_to_user": { "type": "string" }, "description": { "type": "string" }, "feature": { "type": "string" }, "iteration": { "type": "string" }, "created_by_user": { "type": "string" }, "team": { "type": "string" }, "team_status": { "type": "string" }, "program_increment": { "type": "string" }, "time_code": { "type": "string" }, "tags": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "position": { "type": "string" }, "initial_estimate": { "type": "string" }, "detailed_estimate": { "type": "string" }, "remaining_estimate": { "type": "string" }, "work_done": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of requirements", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Requirement" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Requirements" ], "summary": "Create requirement", "operationId": "createRequirement", "x-aha-field-schema": "Requirement", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementCreateInput" } } } }, "responses": { "201": { "description": "The created requirement", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Requirement" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/requirements/{id}": { "get": { "tags": [ "Requirements" ], "summary": "Get requirement", "operationId": "getRequirement", "x-aha-field-schema": "Requirement", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the requirement", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single requirement", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Requirement" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Requirements" ], "summary": "Update requirement", "operationId": "updateRequirement", "x-aha-field-schema": "Requirement", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the requirement", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementUpdateInput" } } } }, "responses": { "200": { "description": "The updated requirement", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Requirement" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Requirements" ], "summary": "Update requirement", "operationId": "patchRequirement", "x-aha-field-schema": "Requirement", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the requirement", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementUpdateInput" } } } }, "responses": { "200": { "description": "The updated requirement", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Requirement" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Requirements" ], "summary": "Delete requirement", "operationId": "deleteRequirement", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the requirement", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/tasks": { "get": { "tags": [ "Tasks" ], "summary": "List tasks", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listTasks", "x-aha-field-schema": "Task", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "type", "due_date", "completed_date", "position", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "type", "due_date", "completed_date", "position", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "created_by_user": { "type": "string" }, "record": { "type": "string" }, "assigned_to": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "type": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "project": { "type": "string" }, "created_by_user": { "type": "string" }, "record": { "type": "string" }, "assigned_to": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "due_date": { "type": "string" }, "completed_date": { "type": "string" }, "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of tasks", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Tasks" ], "summary": "Create task", "operationId": "createTask", "x-aha-field-schema": "Task", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCreateInput" } } } }, "responses": { "201": { "description": "The created task", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Task" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/tasks/{id}": { "get": { "tags": [ "Tasks" ], "summary": "Get task", "operationId": "getTask", "x-aha-field-schema": "Task", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the task", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single task", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Task" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Tasks" ], "summary": "Update task", "operationId": "updateTask", "x-aha-field-schema": "Task", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the task", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateInput" } } } }, "responses": { "200": { "description": "The updated task", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Task" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Tasks" ], "summary": "Update task", "operationId": "patchTask", "x-aha-field-schema": "Task", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the task", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdateInput" } } } }, "responses": { "200": { "description": "The updated task", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Task" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Tasks" ], "summary": "Delete task", "operationId": "deleteTask", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the task", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/projects": { "get": { "tags": [ "Workspaces" ], "summary": "List workspaces", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listProjects", "x-aha-field-schema": "Project", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_prefix", "type", "line", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_prefix", "type", "line", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_prefix": { "type": "string" }, "type": { "type": "string" }, "line": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_prefix": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_prefix": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_prefix": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_prefix": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_prefix": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_prefix": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "watchers": { "type": "string" }, "description": { "type": "string" }, "parent": { "type": "string" }, "children": { "type": "string" }, "idea_portals": { "type": "string" }, "personas": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_prefix": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "watchers": { "type": "string" }, "description": { "type": "string" }, "parent": { "type": "string" }, "children": { "type": "string" }, "idea_portals": { "type": "string" }, "personas": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of workspaces", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Workspaces" ], "summary": "Create workspace", "operationId": "createProject", "x-aha-field-schema": "Project", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreateInput" } } } }, "responses": { "201": { "description": "The created workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/projects/{id}": { "get": { "tags": [ "Workspaces" ], "summary": "Get workspace", "operationId": "getProject", "x-aha-field-schema": "Project", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference prefix of the workspace", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Project" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Workspaces" ], "summary": "Update workspace", "operationId": "updateProject", "x-aha-field-schema": "Project", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference prefix of the workspace", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateInput" } } } }, "responses": { "200": { "description": "The updated workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Workspaces" ], "summary": "Update workspace", "operationId": "patchProject", "x-aha-field-schema": "Project", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference prefix of the workspace", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateInput" } } } }, "responses": { "200": { "description": "The updated workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/applications": { "get": { "tags": [ "Applications" ], "summary": "List applications", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listApplications", "x-aha-field-schema": "Application", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "type", "created_at", "updated_at", "application_status" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "type", "created_at", "updated_at", "application_status" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "application_status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "application_status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "application_status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "application_status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "tags": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "created_by_user": { "type": "string" }, "application_status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "tags": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "created_by_user": { "type": "string" }, "application_status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of applications", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Application" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/applications/{id}": { "get": { "tags": [ "Applications" ], "summary": "Get application", "operationId": "getApplication", "x-aha-field-schema": "Application", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the application", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single application", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Application" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/idea_portals": { "get": { "tags": [ "Idea portals" ], "summary": "List idea portals", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listIdeaPortals", "x-aha-field-schema": "IdeaPortal", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "subtitle", "access", "enabled", "custom_domain", "company_name", "reply_to_email", "created_at", "updated_at", "spam_check_enabled", "indexed_for_crawlers", "display_style", "comment_visibility_enabled", "comment_mentions_enabled", "comment_likes_enabled", "my_org_feedback_enabled", "allow_promoted_records_from_any_project", "idea_restricted", "aha_user_default_idea_visibility", "employee_default_idea_visibility", "portal_user_default_idea_visibility", "aha_user_default_comment_visibility", "employee_default_comment_visibility", "portal_user_default_comment_visibility", "proxy_voting_enabled", "all_proxy_votes_enabled", "my_org_feedback_proxy_votes_enabled", "max_endorsements_per_portal", "max_endorsements_per_idea", "org_count_enabled", "weekly_email_enabled", "unsubscribe_users_by_default", "default_locale", "hide_user_names", "view_all_portal_user_names_enabled", "consent_enabled", "skip_ip_address_restrictions", "require_aha_user_login_enabled", "simple_authentication_enabled" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "subtitle", "access", "enabled", "custom_domain", "company_name", "reply_to_email", "created_at", "updated_at", "spam_check_enabled", "indexed_for_crawlers", "display_style", "comment_visibility_enabled", "comment_mentions_enabled", "comment_likes_enabled", "my_org_feedback_enabled", "allow_promoted_records_from_any_project", "idea_restricted", "aha_user_default_idea_visibility", "employee_default_idea_visibility", "portal_user_default_idea_visibility", "aha_user_default_comment_visibility", "employee_default_comment_visibility", "portal_user_default_comment_visibility", "proxy_voting_enabled", "all_proxy_votes_enabled", "my_org_feedback_proxy_votes_enabled", "max_endorsements_per_portal", "max_endorsements_per_idea", "org_count_enabled", "weekly_email_enabled", "unsubscribe_users_by_default", "default_locale", "hide_user_names", "view_all_portal_user_names_enabled", "consent_enabled", "skip_ip_address_restrictions", "require_aha_user_login_enabled", "simple_authentication_enabled" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "subtitle": { "type": "string" }, "access": { "type": "string" }, "enabled": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "spam_check_enabled": { "type": "string" }, "indexed_for_crawlers": { "type": "string" }, "display_style": { "type": "string" }, "comment_visibility_enabled": { "type": "string" }, "comment_mentions_enabled": { "type": "string" }, "comment_likes_enabled": { "type": "string" }, "my_org_feedback_enabled": { "type": "string" }, "allow_promoted_records_from_any_project": { "type": "string" }, "idea_restricted": { "type": "string" }, "aha_user_default_idea_visibility": { "type": "string" }, "employee_default_idea_visibility": { "type": "string" }, "portal_user_default_idea_visibility": { "type": "string" }, "aha_user_default_comment_visibility": { "type": "string" }, "employee_default_comment_visibility": { "type": "string" }, "portal_user_default_comment_visibility": { "type": "string" }, "proxy_voting_enabled": { "type": "string" }, "all_proxy_votes_enabled": { "type": "string" }, "my_org_feedback_proxy_votes_enabled": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" }, "org_count_enabled": { "type": "string" }, "weekly_email_enabled": { "type": "string" }, "unsubscribe_users_by_default": { "type": "string" }, "default_locale": { "type": "string" }, "hide_user_names": { "type": "string" }, "view_all_portal_user_names_enabled": { "type": "string" }, "consent_enabled": { "type": "string" }, "skip_ip_address_restrictions": { "type": "string" }, "require_aha_user_login_enabled": { "type": "string" }, "simple_authentication_enabled": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "subtitle": { "type": "string" }, "access": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" }, "display_style": { "type": "string" }, "aha_user_default_idea_visibility": { "type": "string" }, "employee_default_idea_visibility": { "type": "string" }, "portal_user_default_idea_visibility": { "type": "string" }, "aha_user_default_comment_visibility": { "type": "string" }, "employee_default_comment_visibility": { "type": "string" }, "portal_user_default_comment_visibility": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" }, "default_locale": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "subtitle": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "subtitle": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "subtitle": { "type": "string" }, "access": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" }, "display_style": { "type": "string" }, "aha_user_default_idea_visibility": { "type": "string" }, "employee_default_idea_visibility": { "type": "string" }, "portal_user_default_idea_visibility": { "type": "string" }, "aha_user_default_comment_visibility": { "type": "string" }, "employee_default_comment_visibility": { "type": "string" }, "portal_user_default_comment_visibility": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" }, "default_locale": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "subtitle": { "type": "string" }, "access": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" }, "display_style": { "type": "string" }, "aha_user_default_idea_visibility": { "type": "string" }, "employee_default_idea_visibility": { "type": "string" }, "portal_user_default_idea_visibility": { "type": "string" }, "aha_user_default_comment_visibility": { "type": "string" }, "employee_default_comment_visibility": { "type": "string" }, "portal_user_default_comment_visibility": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" }, "default_locale": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "subtitle": { "type": "string" }, "access": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "projects": { "type": "string" }, "display_style": { "type": "string" }, "aha_user_default_idea_visibility": { "type": "string" }, "employee_default_idea_visibility": { "type": "string" }, "portal_user_default_idea_visibility": { "type": "string" }, "aha_user_default_comment_visibility": { "type": "string" }, "employee_default_comment_visibility": { "type": "string" }, "portal_user_default_comment_visibility": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" }, "default_locale": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "subtitle": { "type": "string" }, "access": { "type": "string" }, "custom_domain": { "type": "string" }, "company_name": { "type": "string" }, "reply_to_email": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "projects": { "type": "string" }, "display_style": { "type": "string" }, "aha_user_default_idea_visibility": { "type": "string" }, "employee_default_idea_visibility": { "type": "string" }, "portal_user_default_idea_visibility": { "type": "string" }, "aha_user_default_comment_visibility": { "type": "string" }, "employee_default_comment_visibility": { "type": "string" }, "portal_user_default_comment_visibility": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" }, "default_locale": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "max_endorsements_per_portal": { "type": "string" }, "max_endorsements_per_idea": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of idea portals", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/IdeaPortal" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/idea_portals/{id}": { "get": { "tags": [ "Idea portals" ], "summary": "Get idea portal", "operationId": "getIdeaPortal", "x-aha-field-schema": "IdeaPortal", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the idea portal", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single idea portal", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/IdeaPortal" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/portal_users": { "get": { "tags": [ "Portal users" ], "summary": "List portal users", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listPortalUsers", "x-aha-field-schema": "PortalUser", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "enabled", "verified", "unsubscribed", "permission", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "enabled", "verified", "unsubscribed", "permission", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "enabled": { "type": "string" }, "verified": { "type": "string" }, "unsubscribed": { "type": "string" }, "permission": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "permission": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "permission": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "permission": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "permission": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "idea_portal": { "type": "string" }, "idea_user": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "permission": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "idea_portal": { "type": "string" }, "idea_user": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of portal users", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/PortalUser" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/portal_users/{id}": { "get": { "tags": [ "Portal users" ], "summary": "Get portal user", "operationId": "getPortalUser", "x-aha-field-schema": "PortalUser", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the portal user", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single portal user", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/PortalUser" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/idea_users": { "get": { "tags": [ "Idea users" ], "summary": "List idea users", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listIdeaUsers", "x-aha-field-schema": "IdeaUser", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "email", "first_name", "last_name", "title", "phone", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "email", "first_name", "last_name", "title", "phone", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "portal_users": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "title": { "type": "string" }, "phone": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "portal_users": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of idea users", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/IdeaUser" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/idea_users/{id}": { "get": { "tags": [ "Idea users" ], "summary": "Get idea user", "operationId": "getIdeaUser", "x-aha-field-schema": "IdeaUser", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the idea user", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single idea user", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/IdeaUser" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/ideas": { "get": { "tags": [ "Ideas" ], "summary": "List ideas", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listIdeas", "x-aha-field-schema": "Idea", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "score", "spam", "visibility", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "score", "spam", "visibility", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "score": { "type": "string" }, "spam": { "type": "string" }, "visibility": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "score": { "type": "string" }, "visibility": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "score": { "type": "string" }, "visibility": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "score": { "type": "string" }, "visibility": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "score": { "type": "string" }, "visibility": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "project": { "type": "string" }, "description": { "type": "string" }, "assigned_to_user": { "type": "string" }, "submitted_idea_portal": { "type": "string" }, "contributor": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "score": { "type": "string" }, "visibility": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "status": { "type": "string" }, "project": { "type": "string" }, "description": { "type": "string" }, "assigned_to_user": { "type": "string" }, "submitted_idea_portal": { "type": "string" }, "contributor": { "type": "string" }, "score_facts": { "type": "string" }, "watchers": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "score": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "score": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "score": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "score": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "score": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of ideas", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Idea" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/ideas/{id}": { "get": { "tags": [ "Ideas" ], "summary": "Get idea", "operationId": "getIdea", "x-aha-field-schema": "Idea", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the idea", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single idea", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Idea" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/idea_endorsements": { "get": { "tags": [ "Proxy votes" ], "summary": "List proxy votes", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listIdeaEndorsements", "x-aha-field-schema": "IdeaEndorsement", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at", "weight", "value" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at", "weight", "value" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "idea": { "type": "string" }, "idea_organization": { "type": "string" }, "contributor": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" }, "description": { "type": "string" }, "idea": { "type": "string" }, "idea_organization": { "type": "string" }, "contributor": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "weight": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of proxy votes", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/IdeaEndorsement" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/idea_endorsements/{id}": { "get": { "tags": [ "Proxy votes" ], "summary": "Get proxy vote", "operationId": "getIdeaEndorsement", "x-aha-field-schema": "IdeaEndorsement", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the proxy vote", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single proxy vote", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/IdeaEndorsement" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/idea_organizations": { "get": { "tags": [ "Idea organizations" ], "summary": "List idea organizations", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listIdeaOrganizations", "x-aha-field-schema": "IdeaOrganization", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at", "reference_num", "name", "revenue" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at", "reference_num", "name", "revenue" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "reference_num": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "revenue": { "type": "string" }, "description": { "type": "string" }, "creator": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "reference_num": { "type": "string" }, "name": { "type": "string" }, "revenue": { "type": "string" }, "description": { "type": "string" }, "creator": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "revenue": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of idea organizations", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/IdeaOrganization" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/idea_organizations/{id}": { "get": { "tags": [ "Idea organizations" ], "summary": "Get idea organization", "operationId": "getIdeaOrganization", "x-aha-field-schema": "IdeaOrganization", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the idea organization", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single idea organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/IdeaOrganization" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/custom_field_definitions": { "get": { "tags": [ "Custom field definitions" ], "summary": "List custom field definitions", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listCustomFieldDefinitions", "x-aha-field-schema": "CustomFieldDefinition", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "internal_name", "key", "type", "record_type", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "internal_name", "key", "type", "record_type", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "record_type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "record_type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "record_type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "record_type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "record_type": { "type": "string" }, "custom_table": { "type": "string" }, "description": { "type": "string" }, "layouts": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "internal_name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "record_type": { "type": "string" }, "custom_table": { "type": "string" }, "description": { "type": "string" }, "layouts": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of custom field definitions", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDefinition" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Custom field definitions" ], "summary": "Create custom field definition", "operationId": "createCustomFieldDefinition", "x-aha-field-schema": "CustomFieldDefinition", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDefinitionCreateInput" } } } }, "responses": { "201": { "description": "The created custom field definition", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldDefinition" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/custom_field_definitions/{id}": { "get": { "tags": [ "Custom field definitions" ], "summary": "Get custom field definition", "operationId": "getCustomFieldDefinition", "x-aha-field-schema": "CustomFieldDefinition", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the custom field definition", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single custom field definition", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldDefinition" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Custom field definitions" ], "summary": "Update custom field definition", "operationId": "updateCustomFieldDefinition", "x-aha-field-schema": "CustomFieldDefinition", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the custom field definition", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDefinitionUpdateInput" } } } }, "responses": { "200": { "description": "The updated custom field definition", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldDefinition" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Custom field definitions" ], "summary": "Update custom field definition", "operationId": "patchCustomFieldDefinition", "x-aha-field-schema": "CustomFieldDefinition", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the custom field definition", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldDefinitionUpdateInput" } } } }, "responses": { "200": { "description": "The updated custom field definition", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldDefinition" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/custom_field_options": { "get": { "tags": [ "Custom field options" ], "summary": "List custom field options", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listCustomFieldOptions", "x-aha-field-schema": "CustomFieldOption", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "name", "color", "position", "parent_id", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "name", "color", "position", "parent_id", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "position": { "type": "string" }, "parent_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "position": { "type": "string" }, "parent_id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent_id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "position": { "type": "string" }, "parent_id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "position": { "type": "string" }, "parent_id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "custom_field_definition": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "parent_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "custom_field_definition": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "string" }, "parent_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "position": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of custom field options", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOption" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Custom field options" ], "summary": "Create custom field option", "operationId": "createCustomFieldOption", "x-aha-field-schema": "CustomFieldOption", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionCreateInput" } } } }, "responses": { "201": { "description": "The created custom field option", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldOption" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/custom_field_options/{id}": { "get": { "tags": [ "Custom field options" ], "summary": "Get custom field option", "operationId": "getCustomFieldOption", "x-aha-field-schema": "CustomFieldOption", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the custom field option", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single custom field option", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldOption" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Custom field options" ], "summary": "Update custom field option", "operationId": "updateCustomFieldOption", "x-aha-field-schema": "CustomFieldOption", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the custom field option", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionUpdateInput" } } } }, "responses": { "200": { "description": "The updated custom field option", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldOption" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Custom field options" ], "summary": "Update custom field option", "operationId": "patchCustomFieldOption", "x-aha-field-schema": "CustomFieldOption", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the custom field option", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionUpdateInput" } } } }, "responses": { "200": { "description": "The updated custom field option", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/CustomFieldOption" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Custom field options" ], "summary": "Delete custom field option", "operationId": "deleteCustomFieldOption", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the custom field option", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/users/{id}": { "get": { "tags": [ "Users" ], "summary": "Get user", "operationId": "getUser", "x-aha-field-schema": "User", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the user", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single user", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/User" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v3/automations/:automation_id/automation_logs": { "get": { "tags": [ "Automation logs" ], "summary": "List automation logs", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listAutomationMessages", "x-aha-field-schema": "AutomationMessage", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "severity", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "severity", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "automation": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "automation": { "type": "string" }, "message": { "type": "string" }, "severity": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of automation logs", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationMessage" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } } }, "/api/v3/automations": { "get": { "tags": [ "Automations" ], "summary": "List automations", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listAutomations", "x-aha-field-schema": "Automation", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "trigger_kind", "trigger_record_type", "trigger_field", "enabled", "run_count", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "trigger_kind", "trigger_record_type", "trigger_field", "enabled", "run_count", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "trigger_kind": { "type": "string" }, "trigger_record_type": { "type": "string" }, "trigger_field": { "type": "string" }, "enabled": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "trigger_kind": { "type": "string" }, "trigger_record_type": { "type": "string" }, "trigger_field": { "type": "string" }, "run_count": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "trigger_kind": { "type": "string" }, "trigger_record_type": { "type": "string" }, "trigger_field": { "type": "string" }, "run_count": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "trigger_kind": { "type": "string" }, "trigger_record_type": { "type": "string" }, "trigger_field": { "type": "string" }, "run_count": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "trigger_kind": { "type": "string" }, "trigger_record_type": { "type": "string" }, "trigger_field": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "automatable": { "type": "string" }, "logs": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "trigger_kind": { "type": "string" }, "trigger_record_type": { "type": "string" }, "trigger_field": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "automatable": { "type": "string" }, "logs": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "run_count": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of automations", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Automation" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Automations" ], "summary": "Create automation", "operationId": "createAutomation", "x-aha-field-schema": "Automation", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationCreateInput" } } } }, "responses": { "201": { "description": "The created automation", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Automation" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/automations/{id}": { "get": { "tags": [ "Automations" ], "summary": "Get automation", "operationId": "getAutomation", "x-aha-field-schema": "Automation", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single automation", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Automation" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Automations" ], "summary": "Update automation", "operationId": "updateAutomation", "x-aha-field-schema": "Automation", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationUpdateInput" } } } }, "responses": { "200": { "description": "The updated automation", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Automation" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Automations" ], "summary": "Update automation", "operationId": "patchAutomation", "x-aha-field-schema": "Automation", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationUpdateInput" } } } }, "responses": { "200": { "description": "The updated automation", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Automation" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Automations" ], "summary": "Delete automation", "operationId": "deleteAutomation", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/automation_actions": { "get": { "tags": [ "Automation actions" ], "summary": "List automation actions", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listAutomationActions", "x-aha-field-schema": "AutomationAction", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "created_at", "updated_at" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "automation": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "automation": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of automation actions", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationAction" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Automation actions" ], "summary": "Create automation action", "operationId": "createAutomationAction", "x-aha-field-schema": "AutomationAction", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationActionCreateInput" } } } }, "responses": { "201": { "description": "The created automation action", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/AutomationAction" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/automation_actions/{id}": { "get": { "tags": [ "Automation actions" ], "summary": "Get automation action", "operationId": "getAutomationAction", "x-aha-field-schema": "AutomationAction", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation action", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single automation action", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/AutomationAction" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Automation actions" ], "summary": "Update automation action", "operationId": "updateAutomationAction", "x-aha-field-schema": "AutomationAction", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation action", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationActionUpdateInput" } } } }, "responses": { "200": { "description": "The updated automation action", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/AutomationAction" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Automation actions" ], "summary": "Update automation action", "operationId": "patchAutomationAction", "x-aha-field-schema": "AutomationAction", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation action", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationActionUpdateInput" } } } }, "responses": { "200": { "description": "The updated automation action", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/AutomationAction" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Automation actions" ], "summary": "Delete automation action", "operationId": "deleteAutomationAction", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID of the automation action", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/discovery_interviews": { "get": { "tags": [ "Discovery interviews" ], "summary": "List discovery interviews", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listDiscoveryInterviews", "x-aha-field-schema": "DiscoveryInterview", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_time", "end_time", "status", "mode", "summary" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_time", "end_time", "status", "mode", "summary" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "summary": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "summary": { "type": "string" }, "project": { "type": "string" }, "study": { "type": "string" }, "interview_type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "summary": { "type": "string" }, "project": { "type": "string" }, "study": { "type": "string" }, "interview_type": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_time": { "type": "string" }, "end_time": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of discovery interviews", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/DiscoveryInterview" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Discovery interviews" ], "summary": "Create discovery interview", "operationId": "createDiscoveryInterview", "x-aha-field-schema": "DiscoveryInterview", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryInterviewCreateInput" } } } }, "responses": { "201": { "description": "The created discovery interview", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryInterview" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/discovery_interviews/{id}": { "get": { "tags": [ "Discovery interviews" ], "summary": "Get discovery interview", "operationId": "getDiscoveryInterview", "x-aha-field-schema": "DiscoveryInterview", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery interview", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single discovery interview", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryInterview" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Discovery interviews" ], "summary": "Update discovery interview", "operationId": "updateDiscoveryInterview", "x-aha-field-schema": "DiscoveryInterview", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery interview", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryInterviewUpdateInput" } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "record[name]": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "record[start_time]": { "type": "string", "format": "date-time", "description": "Date and time when the interview starts.", "x-aha-response-field": "start_time" }, "record[end_time]": { "type": "string", "format": "date-time", "description": "Date and time when the interview ends.", "x-aha-response-field": "end_time" }, "record[status]": { "type": "string", "enum": [ "scheduling", "scheduled", "processing", "analyzing", "completed", "canceled" ], "description": "Status of the interview.", "x-aha-response-field": "status" }, "record[mode]": { "type": "string", "enum": [ "in_person", "phone", "video", "focus_group", "observation", "document_analysis" ], "description": "Mode of the interview.", "x-aha-response-field": "mode" }, "record[study_id]": { "type": "string", "description": "ID of the study containing the interview.", "x-aha-response-field": "study" }, "record[interview_type_id]": { "type": "string", "description": "ID of the type of interview.", "x-aha-response-field": "interview_type" }, "record[custom_fields]": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "record[transcript]": { "type": "string", "format": "binary", "description": "Interview transcript. To append content on update, send a TXT, VTT, or DOCX file as record[transcript] using multipart/form-data. Transcript uploads are not supported in application/json requests." } } } } } }, "responses": { "200": { "description": "The updated discovery interview", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryInterview" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Discovery interviews" ], "summary": "Update discovery interview", "operationId": "patchDiscoveryInterview", "x-aha-field-schema": "DiscoveryInterview", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery interview", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryInterviewUpdateInput" } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "record[name]": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "record[start_time]": { "type": "string", "format": "date-time", "description": "Date and time when the interview starts.", "x-aha-response-field": "start_time" }, "record[end_time]": { "type": "string", "format": "date-time", "description": "Date and time when the interview ends.", "x-aha-response-field": "end_time" }, "record[status]": { "type": "string", "enum": [ "scheduling", "scheduled", "processing", "analyzing", "completed", "canceled" ], "description": "Status of the interview.", "x-aha-response-field": "status" }, "record[mode]": { "type": "string", "enum": [ "in_person", "phone", "video", "focus_group", "observation", "document_analysis" ], "description": "Mode of the interview.", "x-aha-response-field": "mode" }, "record[study_id]": { "type": "string", "description": "ID of the study containing the interview.", "x-aha-response-field": "study" }, "record[interview_type_id]": { "type": "string", "description": "ID of the type of interview.", "x-aha-response-field": "interview_type" }, "record[custom_fields]": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "record[transcript]": { "type": "string", "format": "binary", "description": "Interview transcript. To append content on update, send a TXT, VTT, or DOCX file as record[transcript] using multipart/form-data. Transcript uploads are not supported in application/json requests." } } } } } }, "responses": { "200": { "description": "The updated discovery interview", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryInterview" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Discovery interviews" ], "summary": "Delete discovery interview", "operationId": "deleteDiscoveryInterview", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery interview", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } }, "/api/v3/discovery_studies": { "get": { "tags": [ "Discovery studies" ], "summary": "List discovery studies", "description": "See [Filtering](#section/Filtering) for syntax and examples, and\n[Pagination](#section/Pagination) for paging and sorting limits.", "operationId": "listDiscoveryStudies", "x-aha-field-schema": "DiscoveryStudy", "x-aha-field-mode": "list", "x-aha-description": null, "parameters": [ { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/After" }, { "$ref": "#/components/parameters/Fields" }, { "name": "sort.asc", "in": "query", "required": false, "description": "Sort ascending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "status" ] } }, { "name": "sort.desc", "in": "query", "required": false, "description": "Sort descending by field. See [Pagination](#section/Pagination) for the sorted record limit.", "schema": { "type": "string", "enum": [ "id", "name", "reference_num", "created_at", "updated_at", "start_date", "end_date", "status" ] } }, { "name": "filter.eq", "in": "query", "required": false, "description": "Equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_eq", "in": "query", "required": false, "description": "Not equals. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.contains", "in": "query", "required": false, "description": "Contains substring (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.starts_with", "in": "query", "required": false, "description": "Starts with (case-insensitive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "name": { "type": "string" }, "reference_num": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.in", "in": "query", "required": false, "description": "In comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_in", "in": "query", "required": false, "description": "Not in comma-separated list. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.empty", "in": "query", "required": false, "description": "Is null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "status": { "type": "string" }, "researchers": { "type": "string" }, "study_type": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "interviews": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.not_empty", "in": "query", "required": false, "description": "Is not null/empty (pass 'true'). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reference_num": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" }, "status": { "type": "string" }, "researchers": { "type": "string" }, "study_type": { "type": "string" }, "description": { "type": "string" }, "project": { "type": "string" }, "interviews": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gt", "in": "query", "required": false, "description": "Greater than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.gte", "in": "query", "required": false, "description": "Greater than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lt", "in": "query", "required": false, "description": "Less than. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.lte", "in": "query", "required": false, "description": "Less than or equal. See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "additionalProperties": { "type": "string" } } }, { "name": "filter.between", "in": "query", "required": false, "description": "Between two comma-separated values (inclusive). See [Filtering](#section/Filtering) for syntax and sub-attributes.", "style": "deepObject", "explode": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_date": { "type": "string" }, "end_date": { "type": "string" } }, "additionalProperties": { "type": "string" } } } ], "responses": { "200": { "description": "A list of discovery studies", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/DiscoveryStudy" } }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" } } }, "post": { "tags": [ "Discovery studies" ], "summary": "Create discovery study", "operationId": "createDiscoveryStudy", "x-aha-field-schema": "DiscoveryStudy", "x-aha-field-mode": "create", "parameters": [ { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryStudyCreateInput" } } } }, "responses": { "201": { "description": "The created discovery study", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryStudy" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } } }, "/api/v3/discovery_studies/{id}": { "get": { "tags": [ "Discovery studies" ], "summary": "Get discovery study", "operationId": "getDiscoveryStudy", "x-aha-field-schema": "DiscoveryStudy", "x-aha-field-mode": "get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery study", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "responses": { "200": { "description": "A single discovery study", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryStudy" } } } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Discovery studies" ], "summary": "Update discovery study", "operationId": "updateDiscoveryStudy", "x-aha-field-schema": "DiscoveryStudy", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery study", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryStudyUpdateInput" } } } }, "responses": { "200": { "description": "The updated discovery study", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryStudy" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "patch": { "tags": [ "Discovery studies" ], "summary": "Update discovery study", "operationId": "patchDiscoveryStudy", "x-aha-field-schema": "DiscoveryStudy", "x-aha-field-mode": "update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery study", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/Fields" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoveryStudyUpdateInput" } } } }, "responses": { "200": { "description": "The updated discovery study", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/DiscoveryStudy" } } } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "422": { "$ref": "#/components/responses/ValidationFailed" } } }, "delete": { "tags": [ "Discovery studies" ], "summary": "Delete discovery study", "operationId": "deleteDiscoveryStudy", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID or reference number of the discovery study", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/DeletionFailed" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "API key or OAuth2 access token. See [Authentication](#section/Authentication)." } }, "schemas": { "Goal": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "effort": { "type": "integer", "description": "Estimated effort, from 0 to 100." }, "value": { "type": "integer", "description": "Estimated value, from 0 to 100." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_initiatives", "from_initiatives_with_dependents", "from_descendants", "from_descendants_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_key_results", "from_key_results_with_dependents" ], "description": "Method used to calculate goal progress." }, "success_metric_name": { "type": "string", "description": "Name of the goal's success metric." }, "success_metric_description": { "type": "string", "description": "HTML description of the goal's success metric." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "time_frame": { "$ref": "#/components/schemas/TimeFrameNested", "description": "Time frame assigned to the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "features": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Features associated with the goal. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=features[default]). Capped at 25 records. Only available on the top-level resource." }, "epics": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/EpicNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Epics associated with the goal. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=epics[default]). Capped at 25 records. Only available on the top-level resource." }, "initiatives": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/InitiativeNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Initiatives associated with the goal. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=initiatives[default]). Capped at 25 records. Only available on the top-level resource." }, "rollup_goals": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/GoalNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Parent goals that this goal rolls up to. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=rollup_goals[default]). Capped at 25 records. Only available on the top-level resource." }, "children": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/GoalNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Child goals that roll up to this goal. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=children[default]). Capped at 25 records. Only available on the top-level resource." }, "key_results": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Key results belonging to the goal. Only available when key results are enabled for the account. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=key_results[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field", "sortable": true }, "effort": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "value": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "success_metric_name": { "kind": "field" }, "success_metric_description": { "kind": "field" }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "time_frame": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TimeFrameNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "features": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "FeatureNested", "filter_subfields": true }, "epics": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "EpicNested", "filter_subfields": true }, "initiatives": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "InitiativeNested", "filter_subfields": true }, "rollup_goals": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "GoalNested", "filter_subfields": true }, "children": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "GoalNested", "filter_subfields": true }, "key_results": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "collection_selection": "inline", "schema": "KeyResultNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Initiative": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_children", "from_children_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents" ], "description": "How progress is calculated for the initiative." }, "duration_source": { "type": "string", "enum": [ "manual", "from_children", "from_releases", "from_features_epics" ], "description": "How start and end dates are calculated for the initiative." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "effort": { "type": "integer", "description": "Effort value of the initiative, from 0 to 100." }, "value": { "type": "integer", "description": "Value of the initiative, from 0 to 100." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "time_frame": { "$ref": "#/components/schemas/TimeFrameNested", "description": "Time frame assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "parent": { "$ref": "#/components/schemas/InitiativeNested", "description": "Parent initiative." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "goals": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/GoalNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Goals associated with the initiative. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=goals[default]). Capped at 25 records. Only available on the top-level resource." }, "score_facts": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Individual metric values for the initiative's scorecards. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=score_facts[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "score": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field", "sortable": true }, "initial_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "effort": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "value": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_frame": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TimeFrameNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "parent": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "InitiativeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "goals": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "GoalNested", "filter_subfields": true }, "score_facts": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ScoreFactNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Competitor": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "subtitle": { "type": "string", "description": "Subtitle of the competitor." }, "website": { "type": "string", "description": "Website of the competitor." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "color": { "kind": "field", "sortable": true }, "subtitle": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "website": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Persona": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "occupation": { "type": "string", "description": "Occupation of the persona." }, "quote": { "type": "string", "description": "Quote from the persona." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "color": { "kind": "field", "sortable": true }, "occupation": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "quote": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Tag": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "type": { "type": "string", "enum": [ "general", "research" ], "description": "Type of the tag. research requires Aha! Discovery." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "color": { "kind": "field" } }, "description": "Default fields: id, name" }, "Annotation": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "type": { "type": "string", "enum": [ "point", "text", "whiteboard_object", "prototype_comment", "quote", "response", "learning", "record", "summary", "clip" ], "description": "Annotation type." }, "text": { "type": "string", "description": "Annotated text." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "tags": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/TagNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Annotation tags. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=tags[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "text": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "tags": { "kind": "collection", "collection_selection": "inline", "schema": "TagNested" } }, "description": "Default fields: id, type, text" }, "Iteration": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "status": { "type": "string", "description": "Status of the iteration." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "duration": { "type": "integer", "description": "Duration of the iteration." }, "goal": { "type": "string", "description": "Goal of the iteration." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "features": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Features associated with the iteration. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=features[default]). Capped at 25 records. Only available on the top-level resource." }, "requirements": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Requirements associated with the record. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=requirements[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field" }, "duration": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "goal": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "features": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "FeatureNested", "filter_subfields": true }, "requirements": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "RequirementNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "ProgramIncrement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "owner": { "$ref": "#/components/schemas/UserNested", "description": "Owner of the program increment." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true }, "url": { "kind": "field", "default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "progress": { "kind": "field" }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "owner": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "KeyResult": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "name": { "type": "string", "description": "Name of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "target_metric": { "type": "string", "description": "Target value of the key result's metric." }, "starting_metric": { "type": "string", "description": "Starting value of the key result's metric." }, "current_metric": { "type": "string", "description": "Current value of the key result's metric." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "goal": { "$ref": "#/components/schemas/GoalNested", "description": "Goal that contains the key result." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "target_metric": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "starting_metric": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "current_metric": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "goal": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "GoalNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "StrategyModel": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "name": { "type": "string", "description": "Name of the record." }, "kind": { "type": "string", "description": "User-defined kind of business model, inherited from its linked template when present." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "time_frame": { "$ref": "#/components/schemas/TimeFrameNested", "description": "Time frame assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." }, "components": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessModelComponentNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Components of the business model. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=components[default]). Capped at 25 records. Only available on the top-level resource." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "kind": { "kind": "field" }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_frame": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TimeFrameNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true }, "components": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "BusinessModelComponentNested", "filter_subfields": true }, "html_url": { "kind": "field", "default": true }, "url": { "kind": "field", "default": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "StrategyVision": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Vision name derived from its workspace name." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "components": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/StrategyVisionComponentNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Components of the strategy vision. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=components[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "components": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "StrategyVisionComponentNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name" }, "StrategyVisionComponent": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "title": { "type": "string", "description": "Title of the vision component." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "strategy_vision": { "$ref": "#/components/schemas/StrategyVisionNested", "description": "Strategy vision that contains the component." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true }, "url": { "kind": "field", "default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "title": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "strategy_vision": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StrategyVisionNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "description": "Default fields: id, html_url, url, name" }, "StrategyPosition": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "name": { "type": "string", "description": "Name of the record." }, "kind": { "type": "string", "description": "User-defined kind of business model, inherited from its linked template when present." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "time_frame": { "$ref": "#/components/schemas/TimeFrameNested", "description": "Time frame assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." }, "components": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessModelComponentNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Components of the business model. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=components[default]). Capped at 25 records. Only available on the top-level resource." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "kind": { "kind": "field" }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_frame": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TimeFrameNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true }, "components": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "BusinessModelComponentNested", "filter_subfields": true }, "html_url": { "kind": "field", "default": true }, "url": { "kind": "field", "default": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "BusinessModelComponent": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "business_model": { "$ref": "#/components/schemas/BusinessModelNested", "description": "Business model that contains the component." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "business_model": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "BusinessModelNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "description": "Default fields: id, name" }, "Release": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "type": { "type": "string", "enum": [ "release", "rollup_release" ], "description": "Type of the release." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "release_date": { "type": "string", "format": "date", "description": "Release date of the release." }, "released_on": { "type": "string", "format": "date", "description": "Date when the release was released." }, "development_started_on": { "type": "string", "format": "date", "description": "Date when development of the release started." }, "external_release_date": { "type": "string", "format": "date", "description": "External release date of the release." }, "external_date_resolution": { "type": "string", "enum": [ "sync", "exact", "week", "month", "quarter", "half", "year" ], "description": "Precision of the external release date." }, "parking_lot": { "type": "boolean", "description": "Whether the release is a parking lot." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_release_phases", "from_release_phases_with_dependents", "from_todos", "from_todos_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_sub_releases" ], "description": "How progress is calculated for the release." }, "duration_source": { "type": "string", "enum": [ "manual", "from_release_phases_features", "from_sub_releases" ], "description": "How start and end dates are calculated for the release." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "owner": { "$ref": "#/components/schemas/UserNested", "description": "Owner associated with the release." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "parent": { "$ref": "#/components/schemas/ReleaseNested", "description": "Parent associated with the release." }, "features": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Features associated with the release. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=features[default]). Capped at 25 records. Only available on the top-level resource." }, "release_phases": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ReleasePhaseNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Release phases associated with the release. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=release_phases[default]). Capped at 25 records. Only available on the top-level resource." }, "children": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Children associated with the release. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=children[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "release_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "released_on": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "development_started_on": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "external_release_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "external_date_resolution": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "parking_lot": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "owner": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "parent": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "features": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "FeatureNested", "filter_subfields": true }, "release_phases": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ReleasePhaseNested", "filter_subfields": true }, "children": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ReleaseNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "ReleasePhase": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "type": { "type": "string", "enum": [ "milestone", "phase" ], "description": "Type of the release phase." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the release phase." }, "duration_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "How start and end dates are calculated for the release phase." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "release": { "$ref": "#/components/schemas/ReleaseNested", "description": "Release associated with the record." }, "features": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Features associated with the release phase. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=features[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field", "sortable": true }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "release": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "features": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "FeatureNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Feature": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_requirements", "from_requirements_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents" ], "description": "How progress is calculated for the record." }, "duration_source": { "type": "string", "enum": [ "manual", "from_iterations", "from_releases", "from_requirements" ], "description": "How start and end dates are calculated for the record." }, "estimate_source": { "type": "string", "enum": [ "manual", "from_requirements" ], "description": "Whether estimates are entered on the record or calculated from its requirements." }, "epic": { "$ref": "#/components/schemas/EpicNested", "description": "Epic associated with the feature." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "type": { "$ref": "#/components/schemas/WorkflowKindNested", "description": "Type assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "release": { "$ref": "#/components/schemas/ReleaseNested", "description": "Release associated with the record." }, "release_phase": { "$ref": "#/components/schemas/ReleasePhaseNested", "description": "Release phase associated with the record." }, "iteration": { "$ref": "#/components/schemas/IterationNested", "description": "Iteration associated with the record." }, "initiative": { "$ref": "#/components/schemas/InitiativeNested", "description": "Initiative associated with the record." }, "team": { "$ref": "#/components/schemas/ProjectNested", "description": "Team assigned to the record." }, "team_status": { "$ref": "#/components/schemas/StatusNested", "description": "Team status assigned to the record." }, "program_increment": { "$ref": "#/components/schemas/ProgramIncrementNested", "description": "Program increment associated with the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "tags": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/TagNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Tags associated with the feature. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=tags[default]). Capped at 25 records. Only available on the top-level resource." }, "requirements": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Requirements associated with the record. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=requirements[default]). Capped at 25 records. Only available on the top-level resource." }, "goals": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/GoalNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Goals associated with the feature. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=goals[default]). Capped at 25 records. Only available on the top-level resource." }, "key_results": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Key results associated with the feature. Only available when key results are enabled for the account. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=key_results[default]). Capped at 25 records. Only available on the top-level resource." }, "score_facts": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Individual metric values for the feature's scorecards. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=score_facts[default]). Capped at 25 records. Only available on the top-level resource." }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "score": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initial_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "estimate_source": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "epic": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "EpicNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "WorkflowKindNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release_phase": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleasePhaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "iteration": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IterationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initiative": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "InitiativeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team_status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "program_increment": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProgramIncrementNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "tags": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "TagNested", "filter_subfields": true }, "requirements": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "RequirementNested", "filter_subfields": true }, "goals": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "GoalNested", "filter_subfields": true }, "key_results": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "collection_selection": "inline", "schema": "KeyResultNested", "filter_subfields": true }, "score_facts": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ScoreFactNested", "filter_subfields": true }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Epic": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the record." }, "duration_source": { "type": "string", "enum": [ "manual", "from_features", "from_releases" ], "description": "How start and end dates are calculated for the record." }, "estimate_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "Whether estimates are entered on the record or calculated from its features." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "release": { "$ref": "#/components/schemas/ReleaseNested", "description": "Release associated with the record." }, "release_phase": { "$ref": "#/components/schemas/ReleasePhaseNested", "description": "Release phase associated with the record." }, "iteration": { "$ref": "#/components/schemas/IterationNested", "description": "Iteration associated with the record." }, "initiative": { "$ref": "#/components/schemas/InitiativeNested", "description": "Initiative associated with the record." }, "team": { "$ref": "#/components/schemas/ProjectNested", "description": "Team assigned to the record." }, "team_status": { "$ref": "#/components/schemas/StatusNested", "description": "Team status assigned to the record." }, "program_increment": { "$ref": "#/components/schemas/ProgramIncrementNested", "description": "Program increment associated with the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "tags": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/TagNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Tags associated with the epic. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=tags[default]). Capped at 25 records. Only available on the top-level resource." }, "features": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Features associated with the epic. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=features[default]). Capped at 25 records. Only available on the top-level resource." }, "goals": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/GoalNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Goals associated with the epic. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=goals[default]). Capped at 25 records. Only available on the top-level resource." }, "key_results": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Key results associated with the epic. Only available when key results are enabled for the account. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=key_results[default]). Capped at 25 records. Only available on the top-level resource." }, "score_facts": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Individual metric values for the epic's scorecards. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=score_facts[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "score": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initial_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "estimate_source": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release_phase": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleasePhaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "iteration": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IterationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initiative": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "InitiativeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team_status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "program_increment": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProgramIncrementNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "tags": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "TagNested", "filter_subfields": true }, "features": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "FeatureNested", "filter_subfields": true }, "goals": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "GoalNested", "filter_subfields": true }, "key_results": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "collection_selection": "inline", "schema": "KeyResultNested", "filter_subfields": true }, "score_facts": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ScoreFactNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Requirement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "feature": { "$ref": "#/components/schemas/FeatureNested", "description": "Feature associated with the requirement." }, "iteration": { "$ref": "#/components/schemas/IterationNested", "description": "Iteration associated with the record." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the record." }, "team": { "$ref": "#/components/schemas/ProjectNested", "description": "Team assigned to the record." }, "team_status": { "$ref": "#/components/schemas/StatusNested", "description": "Team status assigned to the record." }, "program_increment": { "$ref": "#/components/schemas/ProgramIncrementNested", "description": "Program increment associated with the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "tags": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/TagNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Tags associated with the requirement. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=tags[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initial_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "feature": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "FeatureNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "iteration": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IterationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team_status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "program_increment": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProgramIncrementNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "tags": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "TagNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Task": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "type": { "type": "string", "enum": [ "task", "approval", "work_request" ], "description": "Type of the task." }, "description": { "$ref": "#/components/schemas/TaskDescriptionNested", "description": "HTML description of the record." }, "status": { "type": "string", "enum": [ "pending", "partially_complete", "completed" ], "description": "Overall completion status derived from assignments." }, "due_date": { "type": "string", "format": "date", "description": "Due date of the record." }, "completed_date": { "type": "string", "format": "date", "description": "Date when the task was completed. This is null for unfinished tasks." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the record." }, "record": { "$ref": "#/components/schemas/TaskRecordNested", "description": "Record the task belongs to. This is null for personal tasks." }, "assigned_to": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/TaskAssignmentNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "User, approval group, and workspace assignments. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=assigned_to[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "description": { "kind": "embed", "schema": "TaskDescriptionNested" }, "status": { "kind": "field" }, "due_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "completed_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "record": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TaskRecordNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "TaskAssignmentNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "Project": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_prefix": { "type": "string", "description": "Reference prefix of the project." }, "type": { "type": "string", "enum": [ "product_workspace", "marketing_workspace", "it_workspace", "services_workspace", "project_workspace", "business_workspace", "team", "application" ], "description": "Type of the project." }, "line": { "type": "boolean", "description": "Whether the workspace is a workspace line." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "parent": { "$ref": "#/components/schemas/ProjectNested", "description": "Parent associated with the project." }, "children": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Children associated with the project. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=children[default]). Capped at 25 records. Only available on the top-level resource." }, "idea_portals": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/IdeaPortalNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Idea portals associated with the project. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=idea_portals[default]). Capped at 25 records. Only available on the top-level resource." }, "personas": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/PersonaNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Personas associated with the project. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=personas[default]). Capped at 25 records. Only available on the top-level resource." }, "layouts": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectLayoutNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Custom layouts associated with the project. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=layouts[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_prefix": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "line": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "parent": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "children": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ProjectNested", "filter_subfields": true }, "idea_portals": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "IdeaPortalNested", "filter_subfields": true }, "personas": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "PersonaNested", "filter_subfields": true }, "layouts": { "kind": "collection", "collection_selection": "inline", "schema": "ProjectLayoutNested" } }, "description": "Default fields: id, html_url, url, name, reference_prefix" }, "Application": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "url": { "type": "string", "description": "API URL for the record." }, "reference_prefix": { "type": "string", "description": "Reference prefix of the application." }, "name": { "type": "string", "description": "Name of the record." }, "type": { "type": "string", "enum": [ "application", "prototype" ], "description": "Whether the record is an application or prototype." }, "tags": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/TagNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Tags associated with the application. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=tags[default]). Capped at 25 records. Only available on the top-level resource." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the application." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "Description of the application." }, "production_url": { "type": "string", "description": "Production URL of the application." }, "deployment_status": { "type": "string", "enum": [ "enabled", "disabled", "not_deployed" ], "description": "Deployment status of the application." }, "application_status": { "type": "string", "enum": [ "planning", "developing", "deployed", "archived" ], "description": "Lifecycle status of the application." }, "shared": { "type": "boolean", "description": "Whether the prototype is shared." }, "authentication_methods": { "type": "array", "items": { "type": "string" }, "description": "Authentication methods enabled in production." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true }, "reference_prefix": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "tags": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "TagNested", "filter_subfields": true }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "schema": "NoteNested" }, "production_url": { "kind": "field" }, "deployment_status": { "kind": "field" }, "application_status": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "shared": { "kind": "field" }, "authentication_methods": { "kind": "field" } }, "description": "Default fields: id, url, name, reference_prefix" }, "IdeaPortal": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "external_url": { "type": "string", "description": "External URL for the idea portal." }, "name": { "type": "string", "description": "Name of the record." }, "subtitle": { "type": "string", "description": "Subtitle of the idea portal." }, "access": { "type": "string", "enum": [ "submit_only", "public", "private" ], "description": "Access level of the idea portal." }, "enabled": { "type": "boolean", "description": "Whether the idea portal is enabled." }, "custom_domain": { "type": "string", "description": "Custom domain of the idea portal." }, "company_name": { "type": "string", "description": "Company name of the idea portal." }, "reply_to_email": { "type": "string", "description": "Reply-to email address for the idea portal." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "projects": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Projects associated with the idea portal. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=projects[default]). Capped at 25 records. Only available on the top-level resource." }, "spam_check_enabled": { "type": "boolean", "description": "Whether spam check is enabled for the idea portal." }, "indexed_for_crawlers": { "type": "boolean", "description": "Whether search engine crawlers can index the idea portal." }, "logo_url": { "type": "string", "description": "Logo URL for the idea portal." }, "favicon_url": { "type": "string", "description": "Favicon URL for the idea portal." }, "email_logo_url": { "type": "string", "description": "Email logo URL for the idea portal." }, "display_style": { "type": "string", "enum": [ "legacy_allow_iframe", "no_iframe", "iframe" ], "description": "Display style of the idea portal." }, "custom_css": { "type": "string", "description": "Custom CSS for the idea portal." }, "custom_js": { "type": "string", "description": "Custom JavaScript for the idea portal." }, "custom_header": { "type": "string", "description": "Custom header of the idea portal." }, "custom_footer": { "type": "string", "description": "Custom footer of the idea portal." }, "portal_branding": { "$ref": "#/components/schemas/PortalBrandingNested", "description": "Color branding for the idea portal." }, "comment_visibility_enabled": { "type": "boolean", "description": "Whether comment visibility is enabled for the idea portal." }, "comment_mentions_enabled": { "type": "boolean", "description": "Whether comment mentions is enabled for the idea portal." }, "comment_likes_enabled": { "type": "boolean", "description": "Whether comment likes is enabled for the idea portal." }, "my_org_feedback_enabled": { "type": "boolean", "description": "Whether organization feedback is enabled for the idea portal." }, "allow_promoted_records_from_any_project": { "type": "boolean", "description": "Whether records from any workspace can be promoted to the idea portal." }, "idea_restricted": { "type": "boolean", "description": "Whether ideas are restricted in the idea portal." }, "ai_category_suggestions_enabled": { "type": "boolean", "description": "Whether AI category suggestions are enabled for the idea portal." }, "aha_user_default_idea_visibility": { "type": "string", "enum": [ "creator", "employee", "employee_or_creator", "creator_organization", "public" ], "description": "Default idea visibility for Aha! users in the idea portal." }, "employee_default_idea_visibility": { "type": "string", "enum": [ "creator", "employee", "employee_or_creator", "creator_organization", "public" ], "description": "Default idea visibility for employees in the idea portal." }, "portal_user_default_idea_visibility": { "type": "string", "enum": [ "creator", "employee", "employee_or_creator", "creator_organization", "public" ], "description": "Default idea visibility for portal users in the idea portal." }, "aha_user_default_comment_visibility": { "type": "string", "enum": [ "visible_to_all", "visible_to_creator_and_internal_users" ], "description": "Default comment visibility for Aha! users in the idea portal." }, "employee_default_comment_visibility": { "type": "string", "enum": [ "visible_to_all", "visible_to_creator_and_internal_users" ], "description": "Default comment visibility for employees in the idea portal." }, "portal_user_default_comment_visibility": { "type": "string", "enum": [ "visible_to_all", "visible_to_creator_and_internal_users" ], "description": "Default comment visibility for portal users in the idea portal." }, "proxy_voting_enabled": { "type": "boolean", "description": "Whether proxy voting is enabled for the idea portal." }, "all_proxy_votes_enabled": { "type": "boolean", "description": "Whether all proxy votes are enabled for the idea portal." }, "my_org_feedback_proxy_votes_enabled": { "type": "boolean", "description": "Whether proxy votes are enabled for organization feedback." }, "max_endorsements_per_portal": { "type": "integer", "description": "Maximum endorsements a user can add across the idea portal." }, "max_endorsements_per_idea": { "type": "integer", "description": "Maximum endorsements a user can add to one idea." }, "org_count_enabled": { "type": "boolean", "description": "Whether organization counts are shown in the idea portal." }, "email_enabled": { "type": "boolean", "description": "Whether email is enabled for the idea portal." }, "weekly_email_enabled": { "type": "boolean", "description": "Whether weekly email is enabled for the idea portal." }, "unsubscribe_users_by_default": { "type": "boolean", "description": "Whether idea portal users are unsubscribed by default." }, "summary_email_frequency": { "type": "string", "enum": [ "monthly", "weekly", "daily" ], "description": "Summary email frequency of the idea portal." }, "outbound_email_domain_id": { "type": "string", "description": "ID of the outbound email domain used by the idea portal." }, "email_branding": { "$ref": "#/components/schemas/EmailBrandingNested", "description": "Branding for idea portal emails." }, "default_locale": { "type": "string", "enum": [ "en", "es", "de", "fr", "nl" ], "description": "Default locale of the idea portal." }, "enabled_locales": { "type": "array", "items": { "type": "string" }, "description": "Enabled locales of the idea portal." }, "employee_email_patterns": { "type": "string", "description": "Employee email patterns of the idea portal." }, "self_registration_email_patterns": { "type": "string", "description": "Self registration email patterns of the idea portal." }, "hide_user_names": { "type": "boolean", "description": "Whether user names are hidden in the idea portal." }, "view_all_portal_user_names_enabled": { "type": "boolean", "description": "Whether portal users can view all other portal user names." }, "consent_enabled": { "type": "boolean", "description": "Whether consent is enabled for the idea portal." }, "consent_label": { "type": "string", "description": "Consent label of the idea portal." }, "skip_ip_address_restrictions": { "type": "boolean", "description": "Whether IP address restrictions are ignored for the idea portal." }, "require_aha_user_login_enabled": { "type": "boolean", "description": "Whether Aha! users must sign in to access the idea portal." }, "simple_authentication_enabled": { "type": "boolean", "description": "Whether simple authentication is enabled for the idea portal." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "external_url": { "kind": "field" }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "subtitle": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "access": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "custom_domain": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "company_name": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reply_to_email": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "projects": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ProjectNested", "filter_subfields": true }, "spam_check_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "indexed_for_crawlers": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "logo_url": { "kind": "field" }, "favicon_url": { "kind": "field" }, "email_logo_url": { "kind": "field" }, "display_style": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "custom_css": { "kind": "field" }, "custom_js": { "kind": "field" }, "custom_header": { "kind": "field" }, "custom_footer": { "kind": "field" }, "portal_branding": { "kind": "embed", "schema": "PortalBrandingNested" }, "comment_visibility_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "comment_mentions_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "comment_likes_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "my_org_feedback_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "allow_promoted_records_from_any_project": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "idea_restricted": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "ai_category_suggestions_enabled": { "kind": "field" }, "aha_user_default_idea_visibility": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "employee_default_idea_visibility": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "portal_user_default_idea_visibility": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "aha_user_default_comment_visibility": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "employee_default_comment_visibility": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "portal_user_default_comment_visibility": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "proxy_voting_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "all_proxy_votes_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "my_org_feedback_proxy_votes_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "max_endorsements_per_portal": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "max_endorsements_per_idea": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "org_count_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "email_enabled": { "kind": "field" }, "weekly_email_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "unsubscribe_users_by_default": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "summary_email_frequency": { "kind": "field" }, "outbound_email_domain_id": { "kind": "field" }, "email_branding": { "kind": "embed", "schema": "EmailBrandingNested" }, "default_locale": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "enabled_locales": { "kind": "field" }, "employee_email_patterns": { "kind": "field" }, "self_registration_email_patterns": { "kind": "field" }, "hide_user_names": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "view_all_portal_user_names_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "consent_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "consent_label": { "kind": "field" }, "skip_ip_address_restrictions": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "require_aha_user_login_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "simple_authentication_enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] } }, "description": "Default fields: id, html_url, url, name" }, "PortalUser": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "url": { "type": "string", "description": "API URL for the record." }, "email": { "type": "string", "description": "Email of the portal user." }, "first_name": { "type": "string", "description": "First name of the portal user." }, "last_name": { "type": "string", "description": "Last name of the portal user." }, "name": { "type": "string", "description": "Name of the record." }, "enabled": { "type": "boolean", "description": "Whether the portal user is enabled." }, "verified": { "type": "boolean", "description": "Whether the portal user's email address is verified." }, "unsubscribed": { "type": "boolean", "description": "Whether the portal user is unsubscribed." }, "permission": { "type": "string", "enum": [ "none", "aha", "employee", "public" ], "description": "Permission of the portal user." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "idea_portal": { "$ref": "#/components/schemas/IdeaPortalNested", "description": "Idea portal associated with the portal user." }, "idea_user": { "$ref": "#/components/schemas/IdeaUserNested", "description": "Idea user associated with the portal user." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true }, "email": { "kind": "field", "default": true, "nested_default": true }, "first_name": { "kind": "field" }, "last_name": { "kind": "field" }, "name": { "kind": "field", "default": true, "nested_default": true }, "enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "verified": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "unsubscribed": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "permission": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "idea_portal": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaPortalNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "idea_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "description": "Default fields: id, url, name, email" }, "IdeaUser": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "email": { "type": "string", "description": "Email of the idea user." }, "first_name": { "type": "string", "description": "First name of the idea user." }, "last_name": { "type": "string", "description": "Last name of the idea user." }, "title": { "type": "string", "description": "Title of the idea user." }, "phone": { "type": "string", "description": "Phone of the idea user." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "portal_users": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/PortalUserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Portal users associated with the idea user. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=portal_users[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true }, "email": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "first_name": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "last_name": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "title": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "phone": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "portal_users": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "PortalUserNested", "filter_subfields": true } }, "description": "Default fields: id, url, name, email" }, "Idea": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "endorsements_count": { "type": "integer", "description": "Number of endorsements for the idea." }, "spam": { "type": "boolean", "description": "Whether the idea is marked as spam." }, "visibility": { "type": "string", "enum": [ "aha_only", "creator", "employee", "employee_or_creator", "employee_or_creator_org", "public" ], "description": "Visibility of the idea." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "submitted_idea_portal": { "$ref": "#/components/schemas/IdeaPortalNested", "description": "Submitted idea portal associated with the idea." }, "contributor": { "$ref": "#/components/schemas/IdeaContributorNested", "description": "Contributor associated with the idea." }, "score_facts": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Individual metric values for the idea's scorecards. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=score_facts[default]). Capped at 25 records. Only available on the top-level resource." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "watchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Users watching the record for update notifications. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=watchers[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "score": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "endorsements_count": { "kind": "field" }, "spam": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "visibility": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "submitted_idea_portal": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaPortalNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "contributor": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaContributorNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "score_facts": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ScoreFactNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "watchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "IdeaEndorsement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "weight": { "type": "integer", "description": "Weight of the idea endorsement." }, "value": { "type": "integer", "description": "Value of the idea endorsement." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "idea": { "$ref": "#/components/schemas/IdeaNested", "description": "Idea associated with the idea endorsement." }, "idea_organization": { "$ref": "#/components/schemas/IdeaOrganizationNested", "description": "Idea organization associated with the idea endorsement." }, "contributor": { "$ref": "#/components/schemas/IdeaContributorNested", "description": "Contributor associated with the idea endorsement." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "weight": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "value": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "idea": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "idea_organization": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaOrganizationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "contributor": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaContributorNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url" }, "IdeaOrganization": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "name": { "type": "string", "description": "Name of the record." }, "revenue": { "type": "number", "description": "Revenue of the idea organization." }, "email_domains": { "type": "array", "items": { "type": "string" }, "description": "Email domains of the idea organization." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "creator": { "$ref": "#/components/schemas/IdeaContributorNested", "description": "Creator associated with the idea organization." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "revenue": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "email_domains": { "kind": "field" }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "creator": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaContributorNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "CustomFieldDefinition": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the custom field definition." }, "internal_name": { "type": "string", "description": "Internal name of the custom field definition, shown only to administrators." }, "key": { "type": "string", "description": "Key of the custom field definition. Must be unique per record type and only use lowercase letters, numbers and underscores." }, "type": { "type": "string", "enum": [ "text", "note", "number", "date", "url", "checkbox", "attachment", "predefined_choice_list", "editable_choice_list", "predefined_tags", "tags", "conditional_choice", "scorecard", "worksheet", "many_to_many_relationship", "many_to_one_relationship", "one_to_many_relationship", "users", "workspaces", "goals", "initiatives", "key_results", "releases", "epics", "features", "ideas", "idea_categories", "organizations", "idea_created_by", "competitors", "personas", "creative_briefs" ], "description": "Type of the custom field definition." }, "record_type": { "type": "string", "enum": [ "project", "feature", "epic", "requirement", "release", "release_phase", "initiative", "goal", "key_result", "idea", "idea_endorsement", "idea_organization", "idea_user", "creative_brief", "persona", "competitor", "capacity_investment", "team", "program_increment", "task", "document", "study", "interview", "custom_table" ], "description": "Record type the custom field definition belongs to. Custom table fields use custom_table." }, "custom_table": { "$ref": "#/components/schemas/CustomObjectDefinitionNested", "description": "Custom table the custom field definition belongs to if record_type is custom_table." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "layouts": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenDefinitionNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Layouts the custom field definition appears on. Not settable for account-level or custom table fields, which have no layouts to choose. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=layouts[default]). Capped at 25 records. Only available on the top-level resource." }, "options": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOptionNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Options of a choice custom field definition, including hidden options. Null for other types. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=options[default]). Capped at 25 records. Only available on the top-level resource." }, "prefix": { "type": "string", "description": "Text shown before the value of a number field. Null for other types." }, "suffix": { "type": "string", "description": "Text shown after the value of a number field. Null for other types." }, "use_delimiters": { "type": "boolean", "description": "Whether a number field shows thousands separators. Always false for other types." }, "label": { "type": "string", "description": "Label shown next to a checkbox field. Null for other types." }, "display": { "type": "string", "enum": [ "plain_text", "colored_labels" ], "description": "How a predefined or editable choice list field shows its value. Null for other types." }, "scope": { "type": "string", "enum": [ "account", "project_line", "project", "related" ], "description": "Which records a records field offers as values: all in the account, those in the record's workspace line or workspace, or those related to the record. The scopes available depend on the field type and record type. Null for other types." }, "supported_file_types": { "type": "array", "items": { "type": "string" }, "description": "File extensions an attachment field accepts, from: csv, doc, docx, eml, gif, jpeg, mov, mp4, msg, pdf, png, ppt, pptx, tiff, txt, xls, xlsx. Null or empty allows every file type. Null for other types." }, "linked_custom_table": { "$ref": "#/components/schemas/CustomObjectDefinitionNested", "description": "Custom table a relationship field links to; set on create only and null for other types." }, "project_scope": { "type": "string", "enum": [ "account", "project" ], "description": "Which custom table records a many to many or many to one relationship field offers: all in the account, or those in the record's workspace and its parent lines. Idea organization fields only support account. Null for other types." }, "scoring_system": { "$ref": "#/components/schemas/ScoringSystemNested", "description": "Account scorecard a scorecard field uses; required for scorecard fields and null for other types." }, "worksheet_rows": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/WorksheetRowNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Rows of a worksheet field, in display order. Null for other types. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=worksheet_rows[default]). Capped at 25 records. Only available on the top-level resource." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "internal_name": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "key": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "record_type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "custom_table": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "CustomObjectDefinitionNested", "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "layouts": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "ScreenDefinitionNested", "filter_subfields": true }, "options": { "kind": "collection", "collection_selection": "inline", "schema": "CustomFieldOptionNested" }, "prefix": { "kind": "field" }, "suffix": { "kind": "field" }, "use_delimiters": { "kind": "field" }, "label": { "kind": "field" }, "display": { "kind": "field" }, "scope": { "kind": "field" }, "supported_file_types": { "kind": "field" }, "linked_custom_table": { "kind": "embed", "schema": "CustomObjectDefinitionNested" }, "project_scope": { "kind": "field" }, "scoring_system": { "kind": "embed", "schema": "ScoringSystemNested" }, "worksheet_rows": { "kind": "collection", "collection_selection": "inline", "schema": "WorksheetRowNested" }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "description": "Default fields: id, name, key, type" }, "CustomFieldOption": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "custom_field_definition": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "Choice custom field definition that owns the option." }, "name": { "type": "string", "description": "Name of the option." }, "color": { "type": "string", "description": "Color of the option as a hex value." }, "hidden": { "type": "boolean", "description": "Whether the option is hidden from selection. Hidden options remain on records that already use them." }, "position": { "type": "integer", "description": "Position of the option among its siblings. Options of conditional choice fields are ordered under their parent." }, "parent_id": { "type": "string", "description": "Parent option of a conditional choice field option; set on create only and null for other options." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "CustomFieldDefinitionNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "color": { "kind": "field", "sortable": true }, "hidden": { "kind": "field" }, "position": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "parent_id": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "description": "Default fields: id, name" }, "User": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "url": { "type": "string", "description": "API URL for the record." }, "first_name": { "type": "string", "description": "First name of the user." }, "last_name": { "type": "string", "description": "Last name of the user." }, "name": { "type": "string", "description": "Name of the record." }, "email": { "type": "string", "description": "Email of the user." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true }, "first_name": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "last_name": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true }, "email": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "description": "Default fields: id, url, name, email" }, "AutomationMessage": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "automation": { "$ref": "#/components/schemas/AutomationNested", "description": "Automation that generated the log message." }, "message": { "type": "string", "description": "Message of the automation message." }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ], "description": "Severity of the automation message." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "automation": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AutomationNested", "filter_subfields": true }, "message": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "severity": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "description": "Default fields: id, message, severity, created_at" }, "Automation": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "trigger_kind": { "type": "string", "enum": [ "field_changed", "record_created", "delayed_field_changed" ], "description": "Trigger kind of the automation." }, "trigger_record_type": { "type": "string", "enum": [ "feature", "release", "release_phase", "epic", "requirement", "idea", "initiative", "goal", "key_result", "task", "approval", "work_request", "document" ], "description": "What record type the automation is for." }, "trigger_field": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "score", "release", "watchers", "team", "iteration", "record_risk", "progress", "initial_estimate", "detailed_estimate", "record_links", "custom_field", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "duplicate_idea", "categories", "visibility", "num_endorsements", "num_organizations", "submitted_idea_portal", "parent", "collections", "task_status", "due_date", "approval_groups", "assignees" ], "description": "The field that will cause the automation to trigger for field_changed automations." }, "custom_field_definition": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "Custom field definition ID associated with the automation if trigger_field is custom_field." }, "custom_table": { "$ref": "#/components/schemas/CustomObjectDefinitionNested", "description": "Custom table ID associated with the automation if trigger_record_type is custom_table." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values that will be used to compare against the trigger field to determine if the automation should trigger." }, "change_type": { "type": "string", "enum": [ "specific", "any", "=", "add", "remove", ">", "<", "current", "present", "blank", "present_with_comment", "parking_lot", "non_parking_lot" ], "description": "The operation to use to determine if the automation should trigger." }, "link_filter_type": { "type": "string", "enum": [ "link_type", "linked_record", "linked_record_status" ], "description": "Additional field information when using the record_links trigger_field." }, "field_worksheet_row": { "type": "string", "description": "The worksheet row of a worksheet custom field if applicable." }, "enabled": { "type": "boolean", "description": "Whether the automation is enabled." }, "run_count": { "type": "integer", "description": "Run count of the automation." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "automatable": { "$ref": "#/components/schemas/AutomationTargetNested", "description": "Workspace on which the automation runs." }, "trigger_conditions": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationTriggerConditionConfigNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "A list of additional conditions that must be met for the automation to trigger. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=trigger_conditions[default]). Capped at 25 records. Only available on the top-level resource." }, "logs": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationMessageNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Logs associated with the automation. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=logs[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "trigger_kind": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "trigger_record_type": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "trigger_field": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "custom_field_definition": { "kind": "embed", "schema": "CustomFieldDefinitionNested" }, "custom_table": { "kind": "embed", "schema": "CustomObjectDefinitionNested" }, "values": { "kind": "field" }, "change_type": { "kind": "field" }, "link_filter_type": { "kind": "field" }, "field_worksheet_row": { "kind": "field" }, "enabled": { "kind": "field", "sortable": true, "filter_operators": [ "eq" ] }, "run_count": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "automatable": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AutomationTargetNested", "filter_subfields": true }, "trigger_conditions": { "kind": "collection", "collection_selection": "inline", "schema": "AutomationTriggerConditionConfigNested" }, "logs": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "AutomationMessageNested", "filter_subfields": true } }, "description": "Default fields: id, name" }, "AutomationAction": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "automation": { "$ref": "#/components/schemas/AutomationNested", "description": "Automation that owns the action." }, "type": { "type": "string", "enum": [ "update_field", "update_related_field", "create_comment", "create_task", "create_requirement", "create_document", "create_custom_table_record", "send_email", "send_to_integration", "resend_to_integration", "create_idea_admin_response" ], "description": "Type of the automation action." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "field": { "$ref": "#/components/schemas/AutomationUpdateFieldConfigNested", "description": "Configuration for update_field and update_related_field actions." }, "comment": { "$ref": "#/components/schemas/AutomationCreateCommentConfigNested", "description": "Configuration for create_comment and create_idea_admin_response actions." }, "requirement": { "$ref": "#/components/schemas/AutomationCreateRequirementConfigNested", "description": "Configuration for create_requirement actions." }, "task": { "$ref": "#/components/schemas/AutomationCreateTaskConfigNested", "description": "Configuration for create_task actions." }, "document": { "$ref": "#/components/schemas/AutomationCreateDocumentConfigNested", "description": "Configuration for create_document actions." }, "custom_table_record": { "$ref": "#/components/schemas/AutomationCreateCustomTableRecordConfigNested", "description": "Configuration for create_custom_table_record actions." }, "email": { "$ref": "#/components/schemas/AutomationSendEmailConfigNested", "description": "Configuration for send_email actions." }, "integration_mapping": { "$ref": "#/components/schemas/AutomationSendToIntegrationConfigNested", "description": "Configuration for send_to_integration actions." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "automation": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AutomationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "field" }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "field": { "kind": "embed", "schema": "AutomationUpdateFieldConfigNested" }, "comment": { "kind": "embed", "schema": "AutomationCreateCommentConfigNested" }, "requirement": { "kind": "embed", "schema": "AutomationCreateRequirementConfigNested" }, "task": { "kind": "embed", "schema": "AutomationCreateTaskConfigNested" }, "document": { "kind": "embed", "schema": "AutomationCreateDocumentConfigNested" }, "custom_table_record": { "kind": "embed", "schema": "AutomationCreateCustomTableRecordConfigNested" }, "email": { "kind": "embed", "schema": "AutomationSendEmailConfigNested" }, "integration_mapping": { "kind": "embed", "schema": "AutomationSendToIntegrationConfigNested" } }, "description": "Default fields: id" }, "DiscoveryInterview": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview starts." }, "end_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview ends." }, "status": { "type": "string", "enum": [ "scheduling", "scheduled", "processing", "analyzing", "completed", "canceled" ], "description": "Status of the interview." }, "mode": { "type": "string", "enum": [ "in_person", "phone", "video", "focus_group", "observation", "document_analysis" ], "description": "Mode of the interview." }, "summary": { "type": "string", "description": "Summary of the interview." }, "sentiments": { "type": "array", "items": { "$ref": "#/components/schemas/DiscoverySentimentNested" }, "description": "Sentiment analysis of the interview." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "study": { "$ref": "#/components/schemas/DiscoveryStudyNested", "description": "Study containing the interview." }, "interview_type": { "$ref": "#/components/schemas/DiscoveryInterviewTypeNested", "description": "Type of interview." }, "transcript": { "$ref": "#/components/schemas/NoteNested", "description": "Interview transcript. To append content on update, send a TXT, VTT, or DOCX file as record[transcript] using multipart/form-data. Transcript uploads are not supported in application/json requests." }, "idea_users": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/IdeaUserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Interview participants. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=idea_users[default]). Capped at 25 records. Only available on the top-level resource." }, "annotations": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/DiscoveryAnnotationNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Highlights from the transcript. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=annotations[default]). Capped at 25 records. Only available on the top-level resource." }, "linked_records": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedRecordNested" }, "description": "Records linked to the interview." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_time": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_time": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "mode": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "summary": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "sentiments": { "kind": "embed", "schema": "DiscoverySentimentNested" }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "study": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "DiscoveryStudyNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "interview_type": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "DiscoveryInterviewTypeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "transcript": { "kind": "embed", "schema": "NoteNested" }, "idea_users": { "kind": "collection", "collection_selection": "inline", "schema": "IdeaUserNested" }, "annotations": { "kind": "collection", "collection_selection": "inline", "schema": "DiscoveryAnnotationNested" }, "linked_records": { "kind": "embed", "schema": "LinkedRecordNested" }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "DiscoveryStudy": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "status": { "type": "string", "enum": [ "planned", "in_progress", "postponed", "completed", "canceled" ], "description": "Status of the study." }, "researchers": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Researchers for the study. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=researchers[default]). Capped at 25 records. Only available on the top-level resource." }, "study_type": { "$ref": "#/components/schemas/DiscoveryStudyTypeNested", "description": "Type associated with the study." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "linked_records": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedRecordNested" }, "description": "Records linked to the study." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "interviews": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/DiscoveryInterviewNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "Interviews in the study. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=interviews[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "field", "sortable": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "researchers": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "UserNested", "filter_subfields": true }, "study_type": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "DiscoveryStudyTypeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "linked_records": { "kind": "embed", "schema": "LinkedRecordNested" }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "interviews": { "kind": "collection", "filter_operators": [ "empty", "not_empty" ], "collection_selection": "inline", "schema": "DiscoveryInterviewNested", "filter_subfields": true } }, "description": "Default fields: id, html_url, url, name, reference_num" }, "ScoreFact": { "type": "object", "properties": { "scoring_system_metric_id": { "type": "integer", "description": "ID of the scoring system metric." }, "scoring_system_id": { "type": "integer", "description": "ID of the scoring system the metric belongs to." }, "scoring_system_name": { "type": "string", "description": "Name of the scoring system the metric belongs to." }, "name": { "type": "string", "description": "Name of the scoring system metric." }, "value": { "type": "number", "description": "Value of the metric for this record." } }, "x-aha-fields": { "scoring_system_metric_id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "scoring_system_id": { "kind": "field", "default": true, "nested_default": true }, "scoring_system_name": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "value": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "description": "Default fields: scoring_system_metric_id, scoring_system_id, scoring_system_name, name, value" }, "AutomationTriggerConditionConfig": { "type": "object", "properties": { "field": { "type": "string", "description": "Field evaluated by the automation trigger condition." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values of the automation trigger condition." }, "change_type": { "type": "string", "description": "Type of change matched by the automation trigger condition." }, "field_worksheet_row": { "type": "string", "description": "ID of the subfield evaluated by the automation trigger condition." }, "custom_field_definition": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "Custom field associated with the automation trigger condition." } }, "x-aha-fields": { "field": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "values": { "kind": "field", "default": true, "nested_default": true }, "change_type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "field_worksheet_row": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "custom_field_definition": { "kind": "embed", "default": true, "nested_default": true, "schema": "CustomFieldDefinitionNested" } }, "description": "Default fields: field, values, change_type, field_worksheet_row, custom_field_definition" }, "AutomationUpdateFieldConfig": { "type": "object", "properties": { "custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition if \"field\" is custom_field." }, "field_worksheet_row": { "type": "string", "description": "The worksheet row of a worksheet custom field if applicable." }, "action": { "type": "string", "enum": [ "set", "cleared", "copy", "add", "remove" ], "description": "What type of action that will be performed on the field. If using set/add/remove, you must also provide the \"values\" parameter. If using copy, you must provide the \"source\" parameter." }, "sub_action": { "type": "string", "enum": [ "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after", "flagged", "flagged_with_comment" ], "description": "Additional information for the updating action. To specify relative date changes for date fields, or for record risk actions." }, "values": { "type": "array", "items": { "type": "string" }, "description": "The values that will be used for the updating action. Required when using set/add/remove actions. Use appropriate record IDs, or literal values depending on the field type." }, "source": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "release", "watchers", "iteration", "record_risk", "progress", "initiative_name", "initiative_roll_up_initiative", "initiative_status", "initiative_time_frame", "initiative_end_date", "initiative_start_date", "initiative_goals", "initiative_key_results", "initiative_assigned_to_user", "initiative_created_by_user", "initiative_watchers", "initiative_progress", "initiative_record_risk", "release_name", "release_owner", "release_created_by_user", "release_status", "release_release_date", "release_development_started_on", "release_external_release_date", "release_initiatives", "release_goals", "release_key_results", "release_watchers", "release_progress", "epic_name", "epic_status", "epic_team_status", "epic_initiative", "epic_assigned_to_user", "epic_created_by_user", "epic_end_date", "epic_start_date", "epic_tags", "epic_goals", "epic_key_results", "epic_release", "epic_watchers", "epic_iteration", "epic_progress", "epic_record_risk", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "feature_name", "feature_status", "feature_team_status", "feature_type", "feature_initiative", "feature_assigned_to_user", "feature_created_by_user", "feature_epic", "feature_end_date", "feature_start_date", "feature_tags", "feature_goals", "feature_key_results", "feature_release", "feature_watchers", "feature_iteration", "feature_record_risk", "feature_progress", "categories", "visibility", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "task_status", "due_date", "release_phase_name", "release_phase_start_date", "release_phase_end_date", "release_phase_progress", "release_phase_release", "requirement_name", "requirement_status", "requirement_team_status", "requirement_assigned_to_user", "requirement_created_by_user", "requirement_end_date", "requirement_start_date", "requirement_iteration", "requirement_record_risk", "approval_groups", "assignees", "collections", "current_date", "custom_field" ], "description": "The source of the value for the updating action when copying from another field." }, "source_custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition used as the source for the updating action." }, "source_worksheet_row": { "type": "string", "description": "The row of the worksheet used as the source for the updating action." }, "related_record_type": { "type": "string", "enum": [ "feature", "release", "release_phase", "epic", "requirement", "idea", "initiative", "goal", "key_result", "task", "approval", "work_request" ], "description": "The related record type to update for update_related_field actions." }, "field": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "score", "release", "watchers", "team", "iteration", "record_risk", "progress", "initial_estimate", "detailed_estimate", "record_links", "custom_field", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "duplicate_idea", "categories", "visibility", "num_endorsements", "num_organizations", "submitted_idea_portal", "parent", "collections", "task_status", "due_date", "approval_groups", "assignees" ], "description": "The field that will be updated." } }, "x-aha-fields": { "custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "field_worksheet_row": { "kind": "field", "default": true, "nested_default": true }, "action": { "kind": "field", "default": true, "nested_default": true }, "sub_action": { "kind": "field", "default": true, "nested_default": true }, "values": { "kind": "field", "default": true, "nested_default": true }, "source": { "kind": "field", "default": true, "nested_default": true }, "source_custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "source_worksheet_row": { "kind": "field", "default": true, "nested_default": true }, "related_record_type": { "kind": "field", "default": true, "nested_default": true }, "field": { "kind": "field", "default": true, "nested_default": true } }, "description": "Default fields: related_record_type, field, custom_field_definition_id, field_worksheet_row, action, sub_action, values, source, source_custom_field_definition_id, source_worksheet_row" }, "AutomationCreateCommentConfig": { "type": "object", "properties": { "body": { "type": "string", "description": "The body of the comment" } }, "x-aha-fields": { "body": { "kind": "field", "default": true, "nested_default": true } }, "description": "Default fields: body" }, "AutomationCreateRequirementConfig": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the requirement" }, "body": { "type": "string", "description": "The body of the requirement" }, "assigned_to_user": { "type": "string", "enum": [ "unassigned", "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" ], "description": "How to populate the assigned user field for the requirement" }, "custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition associated with the assigned user." }, "value": { "type": "string", "description": "The value associated with the assigned user." } }, "x-aha-fields": { "name": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true }, "assigned_to_user": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "value": { "kind": "field", "default": true, "nested_default": true } }, "description": "Default fields: name, body, assigned_to_user, custom_field_definition_id, value" }, "AutomationCreateTaskConfig": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "task", "approval", "work_request" ], "description": "The type of task to be created" }, "name": { "type": "string", "description": "The name of the task" }, "body": { "type": "string", "description": "The body of the task" }, "due_date": { "type": "string", "enum": [ "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after" ], "description": "The due date of the task" }, "assigned_to_user": { "type": "string", "enum": [ "unassigned", "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" ], "description": "How to populate the assigned user field for the task" }, "custom_field_definition_id": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "The ID of the custom field definition associated with the assigned user." }, "values": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationRecordValueConfigNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "The values associated with the assigned user. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=values[default]). Capped at 25 records. Only available on the top-level resource." } }, "x-aha-fields": { "type": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true }, "due_date": { "kind": "field", "default": true, "nested_default": true }, "assigned_to_user": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition_id": { "kind": "embed", "default": true, "nested_default": true }, "values": { "kind": "collection", "default": true, "nested_default": true, "collection_selection": "inline", "schema": "AutomationRecordValueConfigNested" } }, "description": "Default fields: type, name, body, due_date, assigned_to_user, custom_field_definition_id, values" }, "AutomationCreateDocumentConfig": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the document" }, "body": { "type": "string", "description": "The body of the document" }, "note_template_id": { "type": "string", "description": "The ID of the note template associated with the document" }, "tag_ids": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the tags associated with the document" }, "inherit_tags": { "type": "boolean", "description": "Whether the document should inherit tags from its parent" } }, "x-aha-fields": { "name": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true }, "note_template_id": { "kind": "field", "default": true, "nested_default": true }, "tag_ids": { "kind": "field", "default": true, "nested_default": true }, "inherit_tags": { "kind": "field", "default": true, "nested_default": true } }, "description": "Default fields: name, body, note_template_id, tag_ids, inherit_tags" }, "AutomationCreateCustomTableRecordConfig": { "type": "object", "properties": { "link_custom_field_definition_id": { "type": "string", "description": "The ID of the custom table link field on the trigger record that the new custom table record is linked through." }, "custom_table_id": { "type": "string", "description": "The ID of the custom table the record is created in. Derived from the link field." }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationCustomTableFieldConfigNested" }, "description": "The custom table fields to set on the new record." } }, "x-aha-fields": { "link_custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "custom_table_id": { "kind": "field", "default": true, "nested_default": true }, "fields": { "kind": "embed", "default": true, "nested_default": true, "schema": "AutomationCustomTableFieldConfigNested" } }, "description": "Default fields: link_custom_field_definition_id, custom_table_id, fields" }, "AutomationSendEmailConfig": { "type": "object", "properties": { "to": { "type": "string", "enum": [ "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" ], "description": "The recipient of the notification." }, "custom_field_definition_id": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "The ID of the custom field definition associated with the notification recipient." }, "values": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationRecordValueConfigNested" }, "description": "Inline collection. Capped at 25 records." }, "url": { "type": "string", "format": "uri", "description": "URL to fetch the full collection with pagination, filtering, and sorting, when this association has a collection endpoint." }, "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_url": { "type": "string", "format": "uri", "description": "Present when more records exist and this association has a collection endpoint." } }, "required": [ "records", "has_more" ], "description": "The values associated with the notification recipient. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=values[default]). Capped at 25 records. Only available on the top-level resource." }, "subject": { "type": "string", "description": "The subject of the notification." }, "body": { "type": "string", "description": "The body of the notification." } }, "x-aha-fields": { "to": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition_id": { "kind": "embed", "default": true, "nested_default": true }, "values": { "kind": "collection", "default": true, "nested_default": true, "collection_selection": "inline", "schema": "AutomationRecordValueConfigNested" }, "subject": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true } }, "description": "Default fields: to, custom_field_definition_id, values, subject, body" }, "CustomFieldRecord": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "sortable": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true } }, "description": "Default fields: id, name" }, "Attachment": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "file_name": { "type": "string", "description": "Name of the file." }, "content_type": { "type": "string", "description": "MIME type of the file." }, "file_size": { "type": "integer", "description": "Size of the file in bytes." }, "download_url": { "type": "string", "description": "URL that downloads the file. Anyone with the URL can download the file, so treat it as a secret. Null for linked files that can't be downloaded." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true }, "file_name": { "kind": "field", "default": true, "nested_default": true }, "content_type": { "kind": "field", "default": true, "nested_default": true }, "file_size": { "kind": "field", "default": true, "nested_default": true }, "download_url": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "default": true, "nested_default": true } }, "description": "Default fields: id, file_name, content_type, file_size, download_url, created_at" }, "GoalNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "effort": { "type": "integer", "description": "Estimated effort, from 0 to 100." }, "value": { "type": "integer", "description": "Estimated value, from 0 to 100." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_initiatives", "from_initiatives_with_dependents", "from_descendants", "from_descendants_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_key_results", "from_key_results_with_dependents" ], "description": "Method used to calculate goal progress." }, "success_metric_name": { "type": "string", "description": "Name of the goal's success metric." }, "success_metric_description": { "type": "string", "description": "HTML description of the goal's success metric." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "time_frame": { "$ref": "#/components/schemas/TimeFrameNested", "description": "Time frame assigned to the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "effort": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "value": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "success_metric_name": { "kind": "field" }, "success_metric_description": { "kind": "field" }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "time_frame": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TimeFrameNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Goal", "description": "Default fields: id, html_url, url, name, reference_num" }, "InitiativeNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_children", "from_children_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents" ], "description": "How progress is calculated for the initiative." }, "duration_source": { "type": "string", "enum": [ "manual", "from_children", "from_releases", "from_features_epics" ], "description": "How start and end dates are calculated for the initiative." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "effort": { "type": "integer", "description": "Effort value of the initiative, from 0 to 100." }, "value": { "type": "integer", "description": "Value of the initiative, from 0 to 100." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "time_frame": { "$ref": "#/components/schemas/TimeFrameNested", "description": "Time frame assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "parent": { "$ref": "#/components/schemas/InitiativeNested", "description": "Parent initiative." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "score": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "initial_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "effort": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "value": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_frame": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TimeFrameNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "parent": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "InitiativeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Initiative", "description": "Default fields: id, html_url, url, name, reference_num" }, "PersonaNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "occupation": { "type": "string", "description": "Occupation of the persona." }, "quote": { "type": "string", "description": "Quote from the persona." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "occupation": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "quote": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Persona", "description": "Default fields: id, html_url, url, name, reference_num" }, "TagNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "type": { "type": "string", "enum": [ "general", "research" ], "description": "Type of the tag. research requires Aha! Discovery." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "color": { "kind": "field" } }, "title": "Tag", "description": "Default fields: id, name" }, "IterationNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "status": { "type": "string", "description": "Status of the iteration." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "duration": { "type": "integer", "description": "Duration of the iteration." }, "goal": { "type": "string", "description": "Goal of the iteration." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field" }, "duration": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "goal": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "title": "Iteration", "description": "Default fields: id, html_url, url, name, reference_num" }, "ProgramIncrementNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "owner": { "$ref": "#/components/schemas/UserNested", "description": "Owner of the program increment." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field" }, "url": { "kind": "field" }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "progress": { "kind": "field" }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "owner": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "ProgramIncrement", "description": "Default fields: id, name, reference_num" }, "KeyResultNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "name": { "type": "string", "description": "Name of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "target_metric": { "type": "string", "description": "Target value of the key result's metric." }, "starting_metric": { "type": "string", "description": "Starting value of the key result's metric." }, "current_metric": { "type": "string", "description": "Current value of the key result's metric." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "goal": { "$ref": "#/components/schemas/GoalNested", "description": "Goal that contains the key result." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "target_metric": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "starting_metric": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "current_metric": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "goal": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "GoalNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "KeyResult", "description": "Default fields: id, html_url, url, name, reference_num" }, "StrategyVisionNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Vision name derived from its workspace name." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true } }, "title": "StrategyVision", "description": "Default fields: id, html_url, url, name" }, "StrategyVisionComponentNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "title": { "type": "string", "description": "Title of the vision component." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "strategy_vision": { "$ref": "#/components/schemas/StrategyVisionNested", "description": "Strategy vision that contains the component." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field" }, "url": { "kind": "field" }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "title": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "strategy_vision": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StrategyVisionNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "title": "StrategyVisionComponent", "description": "Default fields: id, name" }, "BusinessModelComponentNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "business_model": { "$ref": "#/components/schemas/BusinessModelNested", "description": "Business model that contains the component." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "business_model": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "BusinessModelNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "title": "BusinessModelComponent", "description": "Default fields: id, name" }, "ReleaseNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "type": { "type": "string", "enum": [ "release", "rollup_release" ], "description": "Type of the release." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "release_date": { "type": "string", "format": "date", "description": "Release date of the release." }, "released_on": { "type": "string", "format": "date", "description": "Date when the release was released." }, "development_started_on": { "type": "string", "format": "date", "description": "Date when development of the release started." }, "external_release_date": { "type": "string", "format": "date", "description": "External release date of the release." }, "external_date_resolution": { "type": "string", "enum": [ "sync", "exact", "week", "month", "quarter", "half", "year" ], "description": "Precision of the external release date." }, "parking_lot": { "type": "boolean", "description": "Whether the release is a parking lot." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_release_phases", "from_release_phases_with_dependents", "from_todos", "from_todos_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_sub_releases" ], "description": "How progress is calculated for the release." }, "duration_source": { "type": "string", "enum": [ "manual", "from_release_phases_features", "from_sub_releases" ], "description": "How start and end dates are calculated for the release." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "owner": { "$ref": "#/components/schemas/UserNested", "description": "Owner associated with the release." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "parent": { "$ref": "#/components/schemas/ReleaseNested", "description": "Parent associated with the release." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "release_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "released_on": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "development_started_on": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "external_release_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "external_date_resolution": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "parking_lot": { "kind": "field", "filter_operators": [ "eq" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "owner": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "parent": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Release", "description": "Default fields: id, html_url, url, name, reference_num" }, "ReleasePhaseNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "type": { "type": "string", "enum": [ "milestone", "phase" ], "description": "Type of the release phase." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the release phase." }, "duration_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "How start and end dates are calculated for the release phase." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "release": { "$ref": "#/components/schemas/ReleaseNested", "description": "Release associated with the record." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "color": { "kind": "field" }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "release": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "ReleasePhase", "description": "Default fields: id, html_url, url, name, reference_num" }, "FeatureNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_requirements", "from_requirements_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents" ], "description": "How progress is calculated for the record." }, "duration_source": { "type": "string", "enum": [ "manual", "from_iterations", "from_releases", "from_requirements" ], "description": "How start and end dates are calculated for the record." }, "estimate_source": { "type": "string", "enum": [ "manual", "from_requirements" ], "description": "Whether estimates are entered on the record or calculated from its requirements." }, "epic": { "$ref": "#/components/schemas/EpicNested", "description": "Epic associated with the feature." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "type": { "$ref": "#/components/schemas/WorkflowKindNested", "description": "Type assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "release": { "$ref": "#/components/schemas/ReleaseNested", "description": "Release associated with the record." }, "release_phase": { "$ref": "#/components/schemas/ReleasePhaseNested", "description": "Release phase associated with the record." }, "iteration": { "$ref": "#/components/schemas/IterationNested", "description": "Iteration associated with the record." }, "initiative": { "$ref": "#/components/schemas/InitiativeNested", "description": "Initiative associated with the record." }, "team": { "$ref": "#/components/schemas/ProjectNested", "description": "Team assigned to the record." }, "team_status": { "$ref": "#/components/schemas/StatusNested", "description": "Team status assigned to the record." }, "program_increment": { "$ref": "#/components/schemas/ProgramIncrementNested", "description": "Program increment associated with the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "score": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initial_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "estimate_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "epic": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "EpicNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "WorkflowKindNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release_phase": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleasePhaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "iteration": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IterationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initiative": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "InitiativeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team_status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "program_increment": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProgramIncrementNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Feature", "description": "Default fields: id, html_url, url, name, reference_num" }, "EpicNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "progress": { "type": "number", "description": "Progress completed for the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the record." }, "duration_source": { "type": "string", "enum": [ "manual", "from_features", "from_releases" ], "description": "How start and end dates are calculated for the record." }, "estimate_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "Whether estimates are entered on the record or calculated from its features." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "release": { "$ref": "#/components/schemas/ReleaseNested", "description": "Release associated with the record." }, "release_phase": { "$ref": "#/components/schemas/ReleasePhaseNested", "description": "Release phase associated with the record." }, "iteration": { "$ref": "#/components/schemas/IterationNested", "description": "Iteration associated with the record." }, "initiative": { "$ref": "#/components/schemas/InitiativeNested", "description": "Initiative associated with the record." }, "team": { "$ref": "#/components/schemas/ProjectNested", "description": "Team assigned to the record." }, "team_status": { "$ref": "#/components/schemas/StatusNested", "description": "Team status assigned to the record." }, "program_increment": { "$ref": "#/components/schemas/ProgramIncrementNested", "description": "Program increment associated with the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "progress": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "score": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initial_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "progress_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "duration_source": { "kind": "field" }, "estimate_source": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "release_phase": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ReleasePhaseNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "iteration": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IterationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initiative": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "InitiativeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team_status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "program_increment": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProgramIncrementNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Epic", "description": "Default fields: id, html_url, url, name, reference_num" }, "RequirementNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record." }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record." }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record." }, "work_done": { "type": "number", "description": "Work completed for the record." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "feature": { "$ref": "#/components/schemas/FeatureNested", "description": "Feature associated with the requirement." }, "iteration": { "$ref": "#/components/schemas/IterationNested", "description": "Iteration associated with the record." }, "created_by_user": { "$ref": "#/components/schemas/UserNested", "description": "User who created the record." }, "team": { "$ref": "#/components/schemas/ProjectNested", "description": "Team assigned to the record." }, "team_status": { "$ref": "#/components/schemas/StatusNested", "description": "Team status assigned to the record." }, "program_increment": { "$ref": "#/components/schemas/ProgramIncrementNested", "description": "Program increment associated with the record." }, "time_code": { "$ref": "#/components/schemas/TimeCodeNested", "description": "Time code assigned to the record. Only available when timesheets are enabled for the account." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "initial_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "detailed_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "remaining_estimate": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "work_done": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "feature": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "FeatureNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "iteration": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IterationNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_by_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "team_status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "program_increment": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProgramIncrementNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_code": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "conditional": true, "schema": "TimeCodeNested", "filter_subfields": true }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Requirement", "description": "Default fields: id, html_url, url, name, reference_num" }, "ProjectNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_prefix": { "type": "string", "description": "Reference prefix of the project." }, "type": { "type": "string", "enum": [ "product_workspace", "marketing_workspace", "it_workspace", "services_workspace", "project_workspace", "business_workspace", "team", "application" ], "description": "Type of the project." }, "line": { "type": "boolean", "description": "Whether the workspace is a workspace line." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "parent": { "$ref": "#/components/schemas/ProjectNested", "description": "Parent associated with the project." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_prefix": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "line": { "kind": "field", "filter_operators": [ "eq" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "parent": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "title": "Project", "description": "Default fields: id, html_url, url, name, reference_prefix" }, "IdeaPortalNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "external_url": { "type": "string", "description": "External URL for the idea portal." }, "name": { "type": "string", "description": "Name of the record." }, "subtitle": { "type": "string", "description": "Subtitle of the idea portal." }, "access": { "type": "string", "enum": [ "submit_only", "public", "private" ], "description": "Access level of the idea portal." }, "enabled": { "type": "boolean", "description": "Whether the idea portal is enabled." }, "custom_domain": { "type": "string", "description": "Custom domain of the idea portal." }, "company_name": { "type": "string", "description": "Company name of the idea portal." }, "reply_to_email": { "type": "string", "description": "Reply-to email address for the idea portal." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "spam_check_enabled": { "type": "boolean", "description": "Whether spam check is enabled for the idea portal." }, "indexed_for_crawlers": { "type": "boolean", "description": "Whether search engine crawlers can index the idea portal." }, "logo_url": { "type": "string", "description": "Logo URL for the idea portal." }, "favicon_url": { "type": "string", "description": "Favicon URL for the idea portal." }, "email_logo_url": { "type": "string", "description": "Email logo URL for the idea portal." }, "display_style": { "type": "string", "enum": [ "legacy_allow_iframe", "no_iframe", "iframe" ], "description": "Display style of the idea portal." }, "custom_css": { "type": "string", "description": "Custom CSS for the idea portal." }, "custom_js": { "type": "string", "description": "Custom JavaScript for the idea portal." }, "custom_header": { "type": "string", "description": "Custom header of the idea portal." }, "custom_footer": { "type": "string", "description": "Custom footer of the idea portal." }, "portal_branding": { "$ref": "#/components/schemas/PortalBrandingNested", "description": "Color branding for the idea portal." }, "comment_visibility_enabled": { "type": "boolean", "description": "Whether comment visibility is enabled for the idea portal." }, "comment_mentions_enabled": { "type": "boolean", "description": "Whether comment mentions is enabled for the idea portal." }, "comment_likes_enabled": { "type": "boolean", "description": "Whether comment likes is enabled for the idea portal." }, "my_org_feedback_enabled": { "type": "boolean", "description": "Whether organization feedback is enabled for the idea portal." }, "allow_promoted_records_from_any_project": { "type": "boolean", "description": "Whether records from any workspace can be promoted to the idea portal." }, "idea_restricted": { "type": "boolean", "description": "Whether ideas are restricted in the idea portal." }, "ai_category_suggestions_enabled": { "type": "boolean", "description": "Whether AI category suggestions are enabled for the idea portal." }, "aha_user_default_idea_visibility": { "type": "string", "enum": [ "creator", "employee", "employee_or_creator", "creator_organization", "public" ], "description": "Default idea visibility for Aha! users in the idea portal." }, "employee_default_idea_visibility": { "type": "string", "enum": [ "creator", "employee", "employee_or_creator", "creator_organization", "public" ], "description": "Default idea visibility for employees in the idea portal." }, "portal_user_default_idea_visibility": { "type": "string", "enum": [ "creator", "employee", "employee_or_creator", "creator_organization", "public" ], "description": "Default idea visibility for portal users in the idea portal." }, "aha_user_default_comment_visibility": { "type": "string", "enum": [ "visible_to_all", "visible_to_creator_and_internal_users" ], "description": "Default comment visibility for Aha! users in the idea portal." }, "employee_default_comment_visibility": { "type": "string", "enum": [ "visible_to_all", "visible_to_creator_and_internal_users" ], "description": "Default comment visibility for employees in the idea portal." }, "portal_user_default_comment_visibility": { "type": "string", "enum": [ "visible_to_all", "visible_to_creator_and_internal_users" ], "description": "Default comment visibility for portal users in the idea portal." }, "proxy_voting_enabled": { "type": "boolean", "description": "Whether proxy voting is enabled for the idea portal." }, "all_proxy_votes_enabled": { "type": "boolean", "description": "Whether all proxy votes are enabled for the idea portal." }, "my_org_feedback_proxy_votes_enabled": { "type": "boolean", "description": "Whether proxy votes are enabled for organization feedback." }, "max_endorsements_per_portal": { "type": "integer", "description": "Maximum endorsements a user can add across the idea portal." }, "max_endorsements_per_idea": { "type": "integer", "description": "Maximum endorsements a user can add to one idea." }, "org_count_enabled": { "type": "boolean", "description": "Whether organization counts are shown in the idea portal." }, "email_enabled": { "type": "boolean", "description": "Whether email is enabled for the idea portal." }, "weekly_email_enabled": { "type": "boolean", "description": "Whether weekly email is enabled for the idea portal." }, "unsubscribe_users_by_default": { "type": "boolean", "description": "Whether idea portal users are unsubscribed by default." }, "summary_email_frequency": { "type": "string", "enum": [ "monthly", "weekly", "daily" ], "description": "Summary email frequency of the idea portal." }, "outbound_email_domain_id": { "type": "string", "description": "ID of the outbound email domain used by the idea portal." }, "email_branding": { "$ref": "#/components/schemas/EmailBrandingNested", "description": "Branding for idea portal emails." }, "default_locale": { "type": "string", "enum": [ "en", "es", "de", "fr", "nl" ], "description": "Default locale of the idea portal." }, "enabled_locales": { "type": "array", "items": { "type": "string" }, "description": "Enabled locales of the idea portal." }, "employee_email_patterns": { "type": "string", "description": "Employee email patterns of the idea portal." }, "self_registration_email_patterns": { "type": "string", "description": "Self registration email patterns of the idea portal." }, "hide_user_names": { "type": "boolean", "description": "Whether user names are hidden in the idea portal." }, "view_all_portal_user_names_enabled": { "type": "boolean", "description": "Whether portal users can view all other portal user names." }, "consent_enabled": { "type": "boolean", "description": "Whether consent is enabled for the idea portal." }, "consent_label": { "type": "string", "description": "Consent label of the idea portal." }, "skip_ip_address_restrictions": { "type": "boolean", "description": "Whether IP address restrictions are ignored for the idea portal." }, "require_aha_user_login_enabled": { "type": "boolean", "description": "Whether Aha! users must sign in to access the idea portal." }, "simple_authentication_enabled": { "type": "boolean", "description": "Whether simple authentication is enabled for the idea portal." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "external_url": { "kind": "field" }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "subtitle": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "access": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "custom_domain": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "company_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reply_to_email": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "spam_check_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "indexed_for_crawlers": { "kind": "field", "filter_operators": [ "eq" ] }, "logo_url": { "kind": "field" }, "favicon_url": { "kind": "field" }, "email_logo_url": { "kind": "field" }, "display_style": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "custom_css": { "kind": "field" }, "custom_js": { "kind": "field" }, "custom_header": { "kind": "field" }, "custom_footer": { "kind": "field" }, "portal_branding": { "kind": "embed", "schema": "PortalBrandingNested" }, "comment_visibility_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "comment_mentions_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "comment_likes_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "my_org_feedback_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "allow_promoted_records_from_any_project": { "kind": "field", "filter_operators": [ "eq" ] }, "idea_restricted": { "kind": "field", "filter_operators": [ "eq" ] }, "ai_category_suggestions_enabled": { "kind": "field" }, "aha_user_default_idea_visibility": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "employee_default_idea_visibility": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "portal_user_default_idea_visibility": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "aha_user_default_comment_visibility": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "employee_default_comment_visibility": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "portal_user_default_comment_visibility": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "proxy_voting_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "all_proxy_votes_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "my_org_feedback_proxy_votes_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "max_endorsements_per_portal": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "max_endorsements_per_idea": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "org_count_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "email_enabled": { "kind": "field" }, "weekly_email_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "unsubscribe_users_by_default": { "kind": "field", "filter_operators": [ "eq" ] }, "summary_email_frequency": { "kind": "field" }, "outbound_email_domain_id": { "kind": "field" }, "email_branding": { "kind": "embed", "schema": "EmailBrandingNested" }, "default_locale": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "enabled_locales": { "kind": "field" }, "employee_email_patterns": { "kind": "field" }, "self_registration_email_patterns": { "kind": "field" }, "hide_user_names": { "kind": "field", "filter_operators": [ "eq" ] }, "view_all_portal_user_names_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "consent_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "consent_label": { "kind": "field" }, "skip_ip_address_restrictions": { "kind": "field", "filter_operators": [ "eq" ] }, "require_aha_user_login_enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "simple_authentication_enabled": { "kind": "field", "filter_operators": [ "eq" ] } }, "title": "IdeaPortal", "description": "Default fields: id, html_url, url, name" }, "PortalUserNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "url": { "type": "string", "description": "API URL for the record." }, "email": { "type": "string", "description": "Email of the portal user." }, "first_name": { "type": "string", "description": "First name of the portal user." }, "last_name": { "type": "string", "description": "Last name of the portal user." }, "name": { "type": "string", "description": "Name of the record." }, "enabled": { "type": "boolean", "description": "Whether the portal user is enabled." }, "verified": { "type": "boolean", "description": "Whether the portal user's email address is verified." }, "unsubscribed": { "type": "boolean", "description": "Whether the portal user is unsubscribed." }, "permission": { "type": "string", "enum": [ "none", "aha", "employee", "public" ], "description": "Permission of the portal user." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "idea_portal": { "$ref": "#/components/schemas/IdeaPortalNested", "description": "Idea portal associated with the portal user." }, "idea_user": { "$ref": "#/components/schemas/IdeaUserNested", "description": "Idea user associated with the portal user." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true }, "email": { "kind": "field", "default": true, "nested_default": true }, "first_name": { "kind": "field" }, "last_name": { "kind": "field" }, "name": { "kind": "field", "default": true, "nested_default": true }, "enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "verified": { "kind": "field", "filter_operators": [ "eq" ] }, "unsubscribed": { "kind": "field", "filter_operators": [ "eq" ] }, "permission": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "idea_portal": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaPortalNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "idea_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "title": "PortalUser", "description": "Default fields: id, url, name, email" }, "IdeaUserNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "email": { "type": "string", "description": "Email of the idea user." }, "first_name": { "type": "string", "description": "First name of the idea user." }, "last_name": { "type": "string", "description": "Last name of the idea user." }, "title": { "type": "string", "description": "Title of the idea user." }, "phone": { "type": "string", "description": "Phone of the idea user." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "email": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "first_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "last_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "title": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "phone": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "IdeaUser", "description": "Default fields: id, url, name, email" }, "IdeaNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "score": { "type": "number", "description": "Score assigned to the record." }, "endorsements_count": { "type": "integer", "description": "Number of endorsements for the idea." }, "spam": { "type": "boolean", "description": "Whether the idea is marked as spam." }, "visibility": { "type": "string", "enum": [ "aha_only", "creator", "employee", "employee_or_creator", "employee_or_creator_org", "public" ], "description": "Visibility of the idea." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "status": { "$ref": "#/components/schemas/StatusNested", "description": "Status assigned to the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "assigned_to_user": { "$ref": "#/components/schemas/AssignedToUserNested", "description": "User assigned to the record." }, "submitted_idea_portal": { "$ref": "#/components/schemas/IdeaPortalNested", "description": "Submitted idea portal associated with the idea." }, "contributor": { "$ref": "#/components/schemas/IdeaContributorNested", "description": "Contributor associated with the idea." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "score": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "endorsements_count": { "kind": "field" }, "spam": { "kind": "field", "filter_operators": [ "eq" ] }, "visibility": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "StatusNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "assigned_to_user": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AssignedToUserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "submitted_idea_portal": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaPortalNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "contributor": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaContributorNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "Idea", "description": "Default fields: id, html_url, url, name, reference_num" }, "IdeaOrganizationNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "name": { "type": "string", "description": "Name of the record." }, "revenue": { "type": "number", "description": "Revenue of the idea organization." }, "email_domains": { "type": "array", "items": { "type": "string" }, "description": "Email domains of the idea organization." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "creator": { "$ref": "#/components/schemas/IdeaContributorNested", "description": "Creator associated with the idea organization." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "revenue": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "email_domains": { "kind": "field" }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "creator": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "IdeaContributorNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "IdeaOrganization", "description": "Default fields: id, html_url, url, name, reference_num" }, "CustomFieldDefinitionNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the custom field definition." }, "internal_name": { "type": "string", "description": "Internal name of the custom field definition, shown only to administrators." }, "key": { "type": "string", "description": "Key of the custom field definition. Must be unique per record type and only use lowercase letters, numbers and underscores." }, "type": { "type": "string", "enum": [ "text", "note", "number", "date", "url", "checkbox", "attachment", "predefined_choice_list", "editable_choice_list", "predefined_tags", "tags", "conditional_choice", "scorecard", "worksheet", "many_to_many_relationship", "many_to_one_relationship", "one_to_many_relationship", "users", "workspaces", "goals", "initiatives", "key_results", "releases", "epics", "features", "ideas", "idea_categories", "organizations", "idea_created_by", "competitors", "personas", "creative_briefs" ], "description": "Type of the custom field definition." }, "record_type": { "type": "string", "enum": [ "project", "feature", "epic", "requirement", "release", "release_phase", "initiative", "goal", "key_result", "idea", "idea_endorsement", "idea_organization", "idea_user", "creative_brief", "persona", "competitor", "capacity_investment", "team", "program_increment", "task", "document", "study", "interview", "custom_table" ], "description": "Record type the custom field definition belongs to. Custom table fields use custom_table." }, "custom_table": { "$ref": "#/components/schemas/CustomObjectDefinitionNested", "description": "Custom table the custom field definition belongs to if record_type is custom_table." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "prefix": { "type": "string", "description": "Text shown before the value of a number field. Null for other types." }, "suffix": { "type": "string", "description": "Text shown after the value of a number field. Null for other types." }, "use_delimiters": { "type": "boolean", "description": "Whether a number field shows thousands separators. Always false for other types." }, "label": { "type": "string", "description": "Label shown next to a checkbox field. Null for other types." }, "display": { "type": "string", "enum": [ "plain_text", "colored_labels" ], "description": "How a predefined or editable choice list field shows its value. Null for other types." }, "scope": { "type": "string", "enum": [ "account", "project_line", "project", "related" ], "description": "Which records a records field offers as values: all in the account, those in the record's workspace line or workspace, or those related to the record. The scopes available depend on the field type and record type. Null for other types." }, "supported_file_types": { "type": "array", "items": { "type": "string" }, "description": "File extensions an attachment field accepts, from: csv, doc, docx, eml, gif, jpeg, mov, mp4, msg, pdf, png, ppt, pptx, tiff, txt, xls, xlsx. Null or empty allows every file type. Null for other types." }, "linked_custom_table": { "$ref": "#/components/schemas/CustomObjectDefinitionNested", "description": "Custom table a relationship field links to; set on create only and null for other types." }, "project_scope": { "type": "string", "enum": [ "account", "project" ], "description": "Which custom table records a many to many or many to one relationship field offers: all in the account, or those in the record's workspace and its parent lines. Idea organization fields only support account. Null for other types." }, "scoring_system": { "$ref": "#/components/schemas/ScoringSystemNested", "description": "Account scorecard a scorecard field uses; required for scorecard fields and null for other types." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "internal_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "key": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "record_type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "custom_table": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "CustomObjectDefinitionNested", "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "prefix": { "kind": "field" }, "suffix": { "kind": "field" }, "use_delimiters": { "kind": "field" }, "label": { "kind": "field" }, "display": { "kind": "field" }, "scope": { "kind": "field" }, "supported_file_types": { "kind": "field" }, "linked_custom_table": { "kind": "embed", "schema": "CustomObjectDefinitionNested" }, "project_scope": { "kind": "field" }, "scoring_system": { "kind": "embed", "schema": "ScoringSystemNested" }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "title": "CustomFieldDefinition", "description": "Default fields: id, name, key, type" }, "CustomFieldOptionNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "custom_field_definition": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "Choice custom field definition that owns the option." }, "name": { "type": "string", "description": "Name of the option." }, "color": { "type": "string", "description": "Color of the option as a hex value." }, "hidden": { "type": "boolean", "description": "Whether the option is hidden from selection. Hidden options remain on records that already use them." }, "position": { "type": "integer", "description": "Position of the option among its siblings. Options of conditional choice fields are ordered under their parent." }, "parent_id": { "type": "string", "description": "Parent option of a conditional choice field option; set on create only and null for other options." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "CustomFieldDefinitionNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "color": { "kind": "field" }, "hidden": { "kind": "field" }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "parent_id": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "title": "CustomFieldOption", "description": "Default fields: id, name" }, "UserNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "url": { "type": "string", "description": "API URL for the record." }, "first_name": { "type": "string", "description": "First name of the user." }, "last_name": { "type": "string", "description": "Last name of the user." }, "name": { "type": "string", "description": "Name of the record." }, "email": { "type": "string", "description": "Email of the user." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true }, "first_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "last_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true }, "email": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "title": "User", "description": "Default fields: id, url, name, email" }, "AutomationMessageNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "automation": { "$ref": "#/components/schemas/AutomationNested", "description": "Automation that generated the log message." }, "message": { "type": "string", "description": "Message of the automation message." }, "severity": { "type": "string", "enum": [ "info", "warn", "error" ], "description": "Severity of the automation message." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "automation": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AutomationNested", "filter_subfields": true }, "message": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "severity": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "title": "AutomationMessage", "description": "Default fields: id, message, severity, created_at" }, "AutomationNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "trigger_kind": { "type": "string", "enum": [ "field_changed", "record_created", "delayed_field_changed" ], "description": "Trigger kind of the automation." }, "trigger_record_type": { "type": "string", "enum": [ "feature", "release", "release_phase", "epic", "requirement", "idea", "initiative", "goal", "key_result", "task", "approval", "work_request", "document" ], "description": "What record type the automation is for." }, "trigger_field": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "score", "release", "watchers", "team", "iteration", "record_risk", "progress", "initial_estimate", "detailed_estimate", "record_links", "custom_field", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "duplicate_idea", "categories", "visibility", "num_endorsements", "num_organizations", "submitted_idea_portal", "parent", "collections", "task_status", "due_date", "approval_groups", "assignees" ], "description": "The field that will cause the automation to trigger for field_changed automations." }, "custom_field_definition": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "Custom field definition ID associated with the automation if trigger_field is custom_field." }, "custom_table": { "$ref": "#/components/schemas/CustomObjectDefinitionNested", "description": "Custom table ID associated with the automation if trigger_record_type is custom_table." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values that will be used to compare against the trigger field to determine if the automation should trigger." }, "change_type": { "type": "string", "enum": [ "specific", "any", "=", "add", "remove", ">", "<", "current", "present", "blank", "present_with_comment", "parking_lot", "non_parking_lot" ], "description": "The operation to use to determine if the automation should trigger." }, "link_filter_type": { "type": "string", "enum": [ "link_type", "linked_record", "linked_record_status" ], "description": "Additional field information when using the record_links trigger_field." }, "field_worksheet_row": { "type": "string", "description": "The worksheet row of a worksheet custom field if applicable." }, "enabled": { "type": "boolean", "description": "Whether the automation is enabled." }, "run_count": { "type": "integer", "description": "Run count of the automation." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "automatable": { "$ref": "#/components/schemas/AutomationTargetNested", "description": "Workspace on which the automation runs." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "trigger_kind": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "trigger_record_type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "trigger_field": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "custom_field_definition": { "kind": "embed", "schema": "CustomFieldDefinitionNested" }, "custom_table": { "kind": "embed", "schema": "CustomObjectDefinitionNested" }, "values": { "kind": "field" }, "change_type": { "kind": "field" }, "link_filter_type": { "kind": "field" }, "field_worksheet_row": { "kind": "field" }, "enabled": { "kind": "field", "filter_operators": [ "eq" ] }, "run_count": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "automatable": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "AutomationTargetNested", "filter_subfields": true } }, "title": "Automation", "description": "Default fields: id, name" }, "DiscoveryInterviewNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview starts." }, "end_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview ends." }, "status": { "type": "string", "enum": [ "scheduling", "scheduled", "processing", "analyzing", "completed", "canceled" ], "description": "Status of the interview." }, "mode": { "type": "string", "enum": [ "in_person", "phone", "video", "focus_group", "observation", "document_analysis" ], "description": "Mode of the interview." }, "summary": { "type": "string", "description": "Summary of the interview." }, "sentiments": { "type": "array", "items": { "$ref": "#/components/schemas/DiscoverySentimentNested" }, "description": "Sentiment analysis of the interview." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "study": { "$ref": "#/components/schemas/DiscoveryStudyNested", "description": "Study containing the interview." }, "interview_type": { "$ref": "#/components/schemas/DiscoveryInterviewTypeNested", "description": "Type of interview." }, "transcript": { "$ref": "#/components/schemas/NoteNested", "description": "Interview transcript. To append content on update, send a TXT, VTT, or DOCX file as record[transcript] using multipart/form-data. Transcript uploads are not supported in application/json requests." }, "linked_records": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedRecordNested" }, "description": "Records linked to the interview." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_time": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_time": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "mode": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "summary": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "sentiments": { "kind": "embed", "schema": "DiscoverySentimentNested" }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "study": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "DiscoveryStudyNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "interview_type": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "DiscoveryInterviewTypeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "transcript": { "kind": "embed", "schema": "NoteNested" }, "linked_records": { "kind": "embed", "schema": "LinkedRecordNested" }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "DiscoveryInterview", "description": "Default fields: id, html_url, url, name, reference_num" }, "DiscoveryStudyNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record." }, "end_date": { "type": "string", "format": "date", "description": "End date of the record." }, "status": { "type": "string", "enum": [ "planned", "in_progress", "postponed", "completed", "canceled" ], "description": "Status of the study." }, "study_type": { "$ref": "#/components/schemas/DiscoveryStudyTypeNested", "description": "Type associated with the study." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "linked_records": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedRecordNested" }, "description": "Records linked to the study." }, "custom_fields": { "$ref": "#/components/schemas/CustomFields" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "start_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "end_date": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "status": { "kind": "field", "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "study_type": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "DiscoveryStudyTypeNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "linked_records": { "kind": "embed", "schema": "LinkedRecordNested" }, "custom_fields": { "kind": "custom_fields", "custom_field_types": { "text": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "type": "string", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "number": { "type": "decimal", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "date": { "type": "date", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "checkbox": { "type": "boolean", "filter_operators": [ "eq" ] } } } }, "title": "DiscoveryStudy", "description": "Default fields: id, html_url, url, name, reference_num" }, "StatusNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "color": { "type": "string", "description": "Color assigned to the record as a hex value." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "color": { "kind": "field" } }, "title": "Status", "description": "Default fields: id, name" }, "NoteNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "body": { "type": "string", "description": "Body of the note." }, "editor_version": { "type": "integer", "description": "Editor version of the note." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "body": { "kind": "field", "default": true, "nested_default": true }, "editor_version": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "title": "Note", "description": "Default fields: id, body" }, "TimeFrameNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "TimeFrame", "description": "Default fields: id, name" }, "PortalBrandingNested": { "type": "object", "properties": { "accent_color": { "type": "string", "description": "Accent color of the idea portal, as a hex value." }, "header_color": { "type": "string", "description": "Header background color of the idea portal, as a hex value." }, "header_text_color": { "type": "string", "description": "Header text color of the idea portal, as a hex value." }, "main_body_text_color": { "type": "string", "description": "Main body text color of the idea portal, as a hex value." }, "primary_color": { "type": "string", "description": "Primary color of the idea portal, as a hex value." }, "primary_text_color": { "type": "string", "description": "Primary text color of the idea portal, as a hex value." }, "main_background_color": { "type": "string", "description": "Main background color of the idea portal, as a hex value." }, "side_navigation_background_color": { "type": "string", "description": "Side navigation background color of the idea portal, as a hex value." }, "side_navigation_text_color": { "type": "string", "description": "Side navigation text color of the idea portal, as a hex value." }, "secondary_color": { "type": "string", "description": "Secondary color of the idea portal, as a hex value." }, "secondary_text_color": { "type": "string", "description": "Secondary text color of the idea portal, as a hex value." }, "selected_menu_item_color": { "type": "string", "description": "Selected menu item color of the idea portal, as a hex value." }, "selected_menu_item_text_color": { "type": "string", "description": "Selected menu item text color of the idea portal, as a hex value." }, "link_text_color": { "type": "string", "description": "Link text color of the idea portal, as a hex value." }, "panel_background_color": { "type": "string", "description": "Panel background color of the idea portal, as a hex value." } }, "x-aha-fields": { "accent_color": { "kind": "field", "default": true, "nested_default": true }, "header_color": { "kind": "field", "default": true, "nested_default": true }, "header_text_color": { "kind": "field", "default": true, "nested_default": true }, "main_body_text_color": { "kind": "field", "default": true, "nested_default": true }, "primary_color": { "kind": "field", "default": true, "nested_default": true }, "primary_text_color": { "kind": "field", "default": true, "nested_default": true }, "main_background_color": { "kind": "field", "default": true, "nested_default": true }, "side_navigation_background_color": { "kind": "field", "default": true, "nested_default": true }, "side_navigation_text_color": { "kind": "field", "default": true, "nested_default": true }, "secondary_color": { "kind": "field", "default": true, "nested_default": true }, "secondary_text_color": { "kind": "field", "default": true, "nested_default": true }, "selected_menu_item_color": { "kind": "field", "default": true, "nested_default": true }, "selected_menu_item_text_color": { "kind": "field", "default": true, "nested_default": true }, "link_text_color": { "kind": "field", "default": true, "nested_default": true }, "panel_background_color": { "kind": "field", "default": true, "nested_default": true } }, "title": "PortalBranding", "description": "Default fields: accent_color, header_color, header_text_color, main_body_text_color, primary_color, primary_text_color, main_background_color, side_navigation_background_color, side_navigation_text_color, secondary_color, secondary_text_color, selected_menu_item_color, selected_menu_item_text_color, link_text_color, panel_background_color" }, "EmailBrandingNested": { "type": "object", "properties": { "accent_color": { "type": "string", "description": "Accent color used in idea portal emails, as a hex value." }, "font_family": { "type": "string", "description": "Font family used in idea portal emails." }, "font_size": { "type": "string", "description": "Font size used in idea portal emails." }, "alignment": { "type": "string", "description": "Text alignment used in idea portal emails." }, "show_reply_hint": { "type": "boolean", "description": "Whether the reply hint is shown in idea portal emails." }, "quick_comments_enabled": { "type": "boolean", "description": "Whether quick comments are enabled in idea portal emails." }, "thank_you_disabled": { "type": "boolean", "description": "Whether the thank you email is disabled for the idea portal." }, "status_changed_disabled": { "type": "boolean", "description": "Whether the status changed email is disabled for the idea portal." }, "admin_response_disabled": { "type": "boolean", "description": "Whether the admin response email is disabled for the idea portal." }, "new_comment_disabled": { "type": "boolean", "description": "Whether the new comment email is disabled for the idea portal." }, "new_mention_disabled": { "type": "boolean", "description": "Whether the new mention email is disabled for the idea portal." } }, "x-aha-fields": { "accent_color": { "kind": "field", "default": true, "nested_default": true }, "font_family": { "kind": "field", "default": true, "nested_default": true }, "font_size": { "kind": "field", "default": true, "nested_default": true }, "alignment": { "kind": "field", "default": true, "nested_default": true }, "show_reply_hint": { "kind": "field", "default": true, "nested_default": true }, "quick_comments_enabled": { "kind": "field", "default": true, "nested_default": true }, "thank_you_disabled": { "kind": "field", "default": true, "nested_default": true }, "status_changed_disabled": { "kind": "field", "default": true, "nested_default": true }, "admin_response_disabled": { "kind": "field", "default": true, "nested_default": true }, "new_comment_disabled": { "kind": "field", "default": true, "nested_default": true }, "new_mention_disabled": { "kind": "field", "default": true, "nested_default": true } }, "title": "EmailBranding", "description": "Default fields: accent_color, font_family, font_size, alignment, show_reply_hint, quick_comments_enabled, thank_you_disabled, status_changed_disabled, admin_response_disabled, new_comment_disabled, new_mention_disabled" }, "ProjectLayoutNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the custom layout." }, "type": { "type": "string", "enum": [ "project", "document", "persona", "competitor", "creative_brief", "goal", "key_result", "initiative", "release", "release_phase", "idea", "idea_endorsement", "idea_portal", "idea_portal_proxy_votes", "idea_organization", "idea_user", "epic", "feature", "requirement", "capacity_investment", "team", "program_increment", "task", "approval", "work_request", "study", "interview" ], "description": "Type of the custom layout." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] } }, "title": "ProjectLayout", "description": "Default fields: id, name, type" }, "AssignedToUserNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "email": { "type": "string", "description": "Email of the assigned to user." }, "default_assignee": { "type": "boolean", "description": "Whether the assigned user is the default assignee." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true }, "email": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "default_assignee": { "kind": "field" } }, "title": "AssignedToUser", "description": "Default fields: id, name, email" }, "TimeCodeNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "code": { "type": "string", "description": "Code of the time code." }, "description": { "type": "string", "description": "Description of the time code." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "code": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "description": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "TimeCode", "description": "Default fields: id, code" }, "ScoreFactNested": { "type": "object", "properties": { "scoring_system_metric_id": { "type": "integer", "description": "ID of the scoring system metric." }, "scoring_system_id": { "type": "integer", "description": "ID of the scoring system the metric belongs to." }, "scoring_system_name": { "type": "string", "description": "Name of the scoring system the metric belongs to." }, "name": { "type": "string", "description": "Name of the scoring system metric." }, "value": { "type": "number", "description": "Value of the metric for this record." } }, "x-aha-fields": { "scoring_system_metric_id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "scoring_system_id": { "kind": "field", "default": true, "nested_default": true }, "scoring_system_name": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "value": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] } }, "title": "ScoreFact", "description": "Default fields: scoring_system_metric_id, scoring_system_id, scoring_system_name, name, value" }, "WorkflowKindNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "WorkflowKind", "description": "Default fields: id, name" }, "BusinessModelNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "name": { "type": "string", "description": "Name of the record." }, "kind": { "type": "string", "description": "User-defined kind of business model, inherited from its linked template when present." }, "position": { "type": "integer", "description": "Position of the record relative to its siblings." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "project": { "$ref": "#/components/schemas/ProjectNested", "description": "Workspace that contains the record." }, "time_frame": { "$ref": "#/components/schemas/TimeFrameNested", "description": "Time frame assigned to the record." }, "description": { "$ref": "#/components/schemas/NoteNested", "description": "HTML description of the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "reference_num": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "kind": { "kind": "field" }, "position": { "kind": "field", "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "project": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "ProjectNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "time_frame": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TimeFrameNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "description": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "NoteNested", "filter_subfields": true } }, "title": "BusinessModel", "description": "Default fields: id, name, reference_num" }, "TaskDescriptionNested": { "type": "object", "properties": { "body": { "type": "string", "description": "HTML body of the task." } }, "x-aha-fields": { "body": { "kind": "field", "default": true, "nested_default": true } }, "title": "TaskDescription", "description": "Default fields: body" }, "TaskRecordNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "type": { "type": "string", "enum": [ "business_model", "competitor", "creative_brief", "epic", "feature", "feedback_campaign", "idea", "empathy_session", "idea_theme", "poll", "initiative", "iteration", "document", "vision_component", "persona", "program_increment", "project", "vision", "notebook", "release", "release_phase", "requirement", "goal", "goals_chart", "key_result", "interview", "study", "presentation" ], "description": "Record type of the related record." }, "name": { "type": "string", "description": "Name of the record." }, "reference_num": { "type": "string", "description": "Reference number of the record." }, "html_url": { "type": "string", "description": "URL to view the record in Aha!" }, "url": { "type": "string", "description": "API URL for the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "reference_num": { "kind": "field", "default": true, "nested_default": true }, "html_url": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true } }, "title": "TaskRecord", "description": "Default fields: id, type, name, reference_num, html_url, url" }, "TaskAssignmentNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the assigned record." }, "status": { "type": "string", "enum": [ "pending", "completed", "approved", "approved_conditionally", "rejected", "skipped" ], "description": "Status of this assignment." }, "completed_date": { "type": "string", "format": "date-time", "description": "Date and time when this assignment was completed." }, "type": { "type": "string", "enum": [ "user", "approval_group", "project" ], "description": "Type of assignee." }, "name": { "type": "string", "description": "Name of the record." }, "response": { "$ref": "#/components/schemas/TaskAssignmentResponseNested", "description": "Response to the work request." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "status": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "completed_date": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true }, "response": { "kind": "embed", "filter_operators": [ "empty", "not_empty" ], "schema": "TaskAssignmentResponseNested", "filter_subfields": true } }, "title": "TaskAssignment", "description": "Default fields: id, status, completed_date, type, name" }, "TaskAssignmentResponseNested": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/UserNested", "description": "User who responded to the work request." }, "linked_record": { "$ref": "#/components/schemas/LinkedRecordNested", "description": "Record linked to the work request response." } }, "x-aha-fields": { "user": { "kind": "embed", "default": true, "nested_default": true, "filter_operators": [ "empty", "not_empty" ], "schema": "UserNested", "filter_subfields": true, "id_filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "linked_record": { "kind": "embed", "default": true, "nested_default": true, "schema": "LinkedRecordNested" } }, "title": "TaskAssignmentResponse", "description": "Default fields: user, linked_record" }, "LinkedRecordNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "link_type": { "type": "string", "enum": [ "relates_to", "depends_on", "duplicates", "contains", "impacts", "blocks", "research", "release_notes", "pdlc_instructions", "pdlc_meetings", "built_as" ], "description": "Relationship from the parent record to the child record." }, "parent_record": { "$ref": "#/components/schemas/LinkedRecordNested", "description": "Parent of the record link." }, "child_record": { "$ref": "#/components/schemas/LinkedRecordNested", "description": "Child of the record link." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "link_type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "parent_record": { "kind": "embed", "default": true, "nested_default": true, "schema": "LinkedRecordNested" }, "child_record": { "kind": "embed", "default": true, "nested_default": true, "schema": "LinkedRecordNested" } }, "title": "LinkedRecord", "description": "Default fields: id, link_type, parent_record, child_record" }, "IdeaContributorNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "type": { "type": "string", "description": "Type of the idea contributor." }, "first_name": { "type": "string", "description": "First name of the idea contributor." }, "last_name": { "type": "string", "description": "Last name of the idea contributor." }, "name": { "type": "string", "description": "Name of the record." }, "email": { "type": "string", "description": "Email of the idea contributor." }, "url": { "type": "string", "description": "API URL for the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "first_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "last_name": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true }, "email": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "url": { "kind": "field", "default": true, "nested_default": true } }, "title": "IdeaContributor", "description": "Default fields: id, name, email, url" }, "CustomObjectDefinitionNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." }, "key": { "type": "string", "description": "Key of the custom object definition." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "key": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "created_at": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] } }, "title": "CustomObjectDefinition", "description": "Default fields: id, name, key, created_at, updated_at" }, "ScreenDefinitionNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the layout." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "ScreenDefinition", "description": "Default fields: id, name" }, "ScoringSystemNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the scorecard." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "ScoringSystem", "description": "Default fields: id, name" }, "WorksheetRowNested": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the worksheet row." }, "type": { "type": "string", "enum": [ "field", "section" ], "description": "Whether the row is a field or a section heading." }, "name": { "type": "string", "description": "Name of the field, or the text of the section heading." }, "equation": { "type": "string", "description": "Value or equation of a field row. Null when blank and for section rows." }, "format": { "type": "string", "enum": [ "string", "number", "percent", "currency", "date", "boolean" ], "description": "Value format of a field row. Null for section rows." }, "precision": { "type": "integer", "description": "Decimal places (0, 1, 2) of a number or percent row. Null for other rows." }, "show_thousand_separator": { "type": "boolean", "description": "Whether a number or percent row shows thousands separators. Null for other rows." }, "currency": { "type": "string", "enum": [ "us_dollar", "euro", "pound", "yen" ], "description": "Currency of a currency row. Null for other rows." }, "date_format": { "type": "string", "enum": [ "american", "standard", "computer", "month", "full_text_month_year", "abbrev_text_month_year" ], "description": "Date format of a date row. Null for other rows." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "equation": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "format": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "precision": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "show_thousand_separator": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq" ] }, "currency": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "date_format": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] } }, "title": "WorksheetRow", "description": "Default fields: id, type, name, equation, format, precision, show_thousand_separator, currency, date_format" }, "AutomationTargetNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "type": { "type": "string", "description": "Type of the automatable." }, "name": { "type": "string", "description": "Name of the record." }, "url": { "type": "string", "description": "API URL for the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true }, "url": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationTarget", "description": "Default fields: id, name, url" }, "AutomationTriggerConditionConfigNested": { "type": "object", "properties": { "field": { "type": "string", "description": "Field evaluated by the automation trigger condition." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values of the automation trigger condition." }, "change_type": { "type": "string", "description": "Type of change matched by the automation trigger condition." }, "field_worksheet_row": { "type": "string", "description": "ID of the subfield evaluated by the automation trigger condition." }, "custom_field_definition": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "Custom field associated with the automation trigger condition." } }, "x-aha-fields": { "field": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "values": { "kind": "field", "default": true, "nested_default": true }, "change_type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "field_worksheet_row": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "custom_field_definition": { "kind": "embed", "default": true, "nested_default": true, "schema": "CustomFieldDefinitionNested" } }, "title": "AutomationTriggerConditionConfig", "description": "Default fields: field, values, change_type, field_worksheet_row, custom_field_definition" }, "AutomationUpdateFieldConfigNested": { "type": "object", "properties": { "custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition if \"field\" is custom_field." }, "field_worksheet_row": { "type": "string", "description": "The worksheet row of a worksheet custom field if applicable." }, "action": { "type": "string", "enum": [ "set", "cleared", "copy", "add", "remove" ], "description": "What type of action that will be performed on the field. If using set/add/remove, you must also provide the \"values\" parameter. If using copy, you must provide the \"source\" parameter." }, "sub_action": { "type": "string", "enum": [ "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after", "flagged", "flagged_with_comment" ], "description": "Additional information for the updating action. To specify relative date changes for date fields, or for record risk actions." }, "values": { "type": "array", "items": { "type": "string" }, "description": "The values that will be used for the updating action. Required when using set/add/remove actions. Use appropriate record IDs, or literal values depending on the field type." }, "source": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "release", "watchers", "iteration", "record_risk", "progress", "initiative_name", "initiative_roll_up_initiative", "initiative_status", "initiative_time_frame", "initiative_end_date", "initiative_start_date", "initiative_goals", "initiative_key_results", "initiative_assigned_to_user", "initiative_created_by_user", "initiative_watchers", "initiative_progress", "initiative_record_risk", "release_name", "release_owner", "release_created_by_user", "release_status", "release_release_date", "release_development_started_on", "release_external_release_date", "release_initiatives", "release_goals", "release_key_results", "release_watchers", "release_progress", "epic_name", "epic_status", "epic_team_status", "epic_initiative", "epic_assigned_to_user", "epic_created_by_user", "epic_end_date", "epic_start_date", "epic_tags", "epic_goals", "epic_key_results", "epic_release", "epic_watchers", "epic_iteration", "epic_progress", "epic_record_risk", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "feature_name", "feature_status", "feature_team_status", "feature_type", "feature_initiative", "feature_assigned_to_user", "feature_created_by_user", "feature_epic", "feature_end_date", "feature_start_date", "feature_tags", "feature_goals", "feature_key_results", "feature_release", "feature_watchers", "feature_iteration", "feature_record_risk", "feature_progress", "categories", "visibility", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "task_status", "due_date", "release_phase_name", "release_phase_start_date", "release_phase_end_date", "release_phase_progress", "release_phase_release", "requirement_name", "requirement_status", "requirement_team_status", "requirement_assigned_to_user", "requirement_created_by_user", "requirement_end_date", "requirement_start_date", "requirement_iteration", "requirement_record_risk", "approval_groups", "assignees", "collections", "current_date", "custom_field" ], "description": "The source of the value for the updating action when copying from another field." }, "source_custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition used as the source for the updating action." }, "source_worksheet_row": { "type": "string", "description": "The row of the worksheet used as the source for the updating action." }, "related_record_type": { "type": "string", "enum": [ "feature", "release", "release_phase", "epic", "requirement", "idea", "initiative", "goal", "key_result", "task", "approval", "work_request" ], "description": "The related record type to update for update_related_field actions." }, "field": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "score", "release", "watchers", "team", "iteration", "record_risk", "progress", "initial_estimate", "detailed_estimate", "record_links", "custom_field", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "duplicate_idea", "categories", "visibility", "num_endorsements", "num_organizations", "submitted_idea_portal", "parent", "collections", "task_status", "due_date", "approval_groups", "assignees" ], "description": "The field that will be updated." } }, "x-aha-fields": { "custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "field_worksheet_row": { "kind": "field", "default": true, "nested_default": true }, "action": { "kind": "field", "default": true, "nested_default": true }, "sub_action": { "kind": "field", "default": true, "nested_default": true }, "values": { "kind": "field", "default": true, "nested_default": true }, "source": { "kind": "field", "default": true, "nested_default": true }, "source_custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "source_worksheet_row": { "kind": "field", "default": true, "nested_default": true }, "related_record_type": { "kind": "field", "default": true, "nested_default": true }, "field": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationUpdateFieldConfig", "description": "Default fields: related_record_type, field, custom_field_definition_id, field_worksheet_row, action, sub_action, values, source, source_custom_field_definition_id, source_worksheet_row" }, "AutomationCreateCommentConfigNested": { "type": "object", "properties": { "body": { "type": "string", "description": "The body of the comment" } }, "x-aha-fields": { "body": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationCreateCommentConfig", "description": "Default fields: body" }, "AutomationCreateRequirementConfigNested": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the requirement" }, "body": { "type": "string", "description": "The body of the requirement" }, "assigned_to_user": { "type": "string", "enum": [ "unassigned", "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" ], "description": "How to populate the assigned user field for the requirement" }, "custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition associated with the assigned user." }, "value": { "type": "string", "description": "The value associated with the assigned user." } }, "x-aha-fields": { "name": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true }, "assigned_to_user": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "value": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationCreateRequirementConfig", "description": "Default fields: name, body, assigned_to_user, custom_field_definition_id, value" }, "AutomationCreateTaskConfigNested": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "task", "approval", "work_request" ], "description": "The type of task to be created" }, "name": { "type": "string", "description": "The name of the task" }, "body": { "type": "string", "description": "The body of the task" }, "due_date": { "type": "string", "enum": [ "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after" ], "description": "The due date of the task" }, "assigned_to_user": { "type": "string", "enum": [ "unassigned", "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" ], "description": "How to populate the assigned user field for the task" }, "custom_field_definition_id": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "The ID of the custom field definition associated with the assigned user." } }, "x-aha-fields": { "type": { "kind": "field", "default": true, "nested_default": true }, "name": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true }, "due_date": { "kind": "field", "default": true, "nested_default": true }, "assigned_to_user": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition_id": { "kind": "embed", "default": true, "nested_default": true } }, "title": "AutomationCreateTaskConfig", "description": "Default fields: type, name, body, due_date, assigned_to_user, custom_field_definition_id" }, "AutomationRecordValueConfigNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the record" }, "type": { "type": "string", "description": "The type of the record" } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "AutomationRecordValueConfig", "description": "Default fields: id, type" }, "AutomationCreateDocumentConfigNested": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the document" }, "body": { "type": "string", "description": "The body of the document" }, "note_template_id": { "type": "string", "description": "The ID of the note template associated with the document" }, "tag_ids": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the tags associated with the document" }, "inherit_tags": { "type": "boolean", "description": "Whether the document should inherit tags from its parent" } }, "x-aha-fields": { "name": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true }, "note_template_id": { "kind": "field", "default": true, "nested_default": true }, "tag_ids": { "kind": "field", "default": true, "nested_default": true }, "inherit_tags": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationCreateDocumentConfig", "description": "Default fields: name, body, note_template_id, tag_ids, inherit_tags" }, "AutomationCreateCustomTableRecordConfigNested": { "type": "object", "properties": { "link_custom_field_definition_id": { "type": "string", "description": "The ID of the custom table link field on the trigger record that the new custom table record is linked through." }, "custom_table_id": { "type": "string", "description": "The ID of the custom table the record is created in. Derived from the link field." }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationCustomTableFieldConfigNested" }, "description": "The custom table fields to set on the new record." } }, "x-aha-fields": { "link_custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "custom_table_id": { "kind": "field", "default": true, "nested_default": true }, "fields": { "kind": "embed", "default": true, "nested_default": true, "schema": "AutomationCustomTableFieldConfigNested" } }, "title": "AutomationCreateCustomTableRecordConfig", "description": "Default fields: link_custom_field_definition_id, custom_table_id, fields" }, "AutomationCustomTableFieldConfigNested": { "type": "object", "properties": { "custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition being updated." }, "field_worksheet_row": { "type": "string", "description": "The worksheet row of a worksheet custom field if applicable." }, "action": { "type": "string", "enum": [ "set", "cleared", "copy", "add", "remove" ], "description": "What type of action that will be performed on the field. If using set/add/remove, you must also provide the \"values\" parameter. If using copy, you must provide the \"source\" parameter." }, "sub_action": { "type": "string", "enum": [ "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after", "flagged", "flagged_with_comment" ], "description": "Additional information for the updating action. To specify relative date changes for date fields, or for record risk actions." }, "values": { "type": "array", "items": { "type": "string" }, "description": "The values that will be used for the updating action. Required when using set/add/remove actions. Use appropriate record IDs, or literal values depending on the field type." }, "source": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "release", "watchers", "iteration", "record_risk", "progress", "initiative_name", "initiative_roll_up_initiative", "initiative_status", "initiative_time_frame", "initiative_end_date", "initiative_start_date", "initiative_goals", "initiative_key_results", "initiative_assigned_to_user", "initiative_created_by_user", "initiative_watchers", "initiative_progress", "initiative_record_risk", "release_name", "release_owner", "release_created_by_user", "release_status", "release_release_date", "release_development_started_on", "release_external_release_date", "release_initiatives", "release_goals", "release_key_results", "release_watchers", "release_progress", "epic_name", "epic_status", "epic_team_status", "epic_initiative", "epic_assigned_to_user", "epic_created_by_user", "epic_end_date", "epic_start_date", "epic_tags", "epic_goals", "epic_key_results", "epic_release", "epic_watchers", "epic_iteration", "epic_progress", "epic_record_risk", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "feature_name", "feature_status", "feature_team_status", "feature_type", "feature_initiative", "feature_assigned_to_user", "feature_created_by_user", "feature_epic", "feature_end_date", "feature_start_date", "feature_tags", "feature_goals", "feature_key_results", "feature_release", "feature_watchers", "feature_iteration", "feature_record_risk", "feature_progress", "categories", "visibility", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "task_status", "due_date", "release_phase_name", "release_phase_start_date", "release_phase_end_date", "release_phase_progress", "release_phase_release", "requirement_name", "requirement_status", "requirement_team_status", "requirement_assigned_to_user", "requirement_created_by_user", "requirement_end_date", "requirement_start_date", "requirement_iteration", "requirement_record_risk", "approval_groups", "assignees", "collections", "current_date", "custom_field" ], "description": "The source of the value for the updating action when copying from another field." }, "source_custom_field_definition_id": { "type": "string", "description": "The ID of the custom field definition used as the source for the updating action." }, "source_worksheet_row": { "type": "string", "description": "The row of the worksheet used as the source for the updating action." } }, "x-aha-fields": { "custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "field_worksheet_row": { "kind": "field", "default": true, "nested_default": true }, "action": { "kind": "field", "default": true, "nested_default": true }, "sub_action": { "kind": "field", "default": true, "nested_default": true }, "values": { "kind": "field", "default": true, "nested_default": true }, "source": { "kind": "field", "default": true, "nested_default": true }, "source_custom_field_definition_id": { "kind": "field", "default": true, "nested_default": true }, "source_worksheet_row": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationCustomTableFieldConfig", "description": "Default fields: custom_field_definition_id, field_worksheet_row, action, sub_action, values, source, source_custom_field_definition_id, source_worksheet_row" }, "AutomationSendEmailConfigNested": { "type": "object", "properties": { "to": { "type": "string", "enum": [ "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" ], "description": "The recipient of the notification." }, "custom_field_definition_id": { "$ref": "#/components/schemas/CustomFieldDefinitionNested", "description": "The ID of the custom field definition associated with the notification recipient." }, "subject": { "type": "string", "description": "The subject of the notification." }, "body": { "type": "string", "description": "The body of the notification." } }, "x-aha-fields": { "to": { "kind": "field", "default": true, "nested_default": true }, "custom_field_definition_id": { "kind": "embed", "default": true, "nested_default": true }, "subject": { "kind": "field", "default": true, "nested_default": true }, "body": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationSendEmailConfig", "description": "Default fields: to, custom_field_definition_id, subject, body" }, "AutomationSendToIntegrationConfigNested": { "type": "object", "properties": { "integration_id": { "type": "string", "description": "The ID of the integration." }, "entity_name": { "type": "string", "description": "The name of the entity associated with the integration." } }, "x-aha-fields": { "integration_id": { "kind": "field", "default": true, "nested_default": true }, "entity_name": { "kind": "field", "default": true, "nested_default": true } }, "title": "AutomationSendToIntegrationConfig", "description": "Default fields: integration_id, entity_name" }, "DiscoverySentimentNested": { "type": "object", "properties": { "title": { "type": "string", "description": "Topic of the sentiment analysis." }, "sentiment": { "type": "string", "description": "Sentiment expressed about the topic." }, "summary": { "type": "string", "description": "Summary of the sentiment analysis." } }, "x-aha-fields": { "title": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "sentiment": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] }, "summary": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "DiscoverySentiment", "description": "Default fields: title, sentiment, summary" }, "DiscoveryStudyTypeNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "DiscoveryStudyType", "description": "Default fields: id, name" }, "DiscoveryInterviewTypeNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "name": { "type": "string", "description": "Name of the record." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "name": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "contains", "starts_with", "in", "not_in", "empty", "not_empty" ] } }, "title": "DiscoveryInterviewType", "description": "Default fields: id, name" }, "DiscoveryAnnotationNested": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique record ID." }, "type": { "type": "string", "enum": [ "quote", "learning", "record", "summary", "response", "clip" ], "description": "Highlight type." }, "text": { "type": "string", "description": "Text of the highlight." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the record was last updated." }, "title": { "type": "string", "description": "Title of the highlight." }, "speaker": { "type": "string", "description": "Speaker name." }, "start_time": { "type": "number", "description": "Start time of the highlight in seconds." }, "end_time": { "type": "number", "description": "End time of the highlight in seconds." } }, "x-aha-fields": { "id": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "gt", "gte", "lt", "lte", "in", "not_in", "between", "empty", "not_empty" ] }, "type": { "kind": "field", "default": true, "nested_default": true, "filter_operators": [ "eq", "not_eq", "in", "not_in", "empty", "not_empty" ] }, "text": { "kind": "field", "default": true, "nested_default": true }, "created_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "updated_at": { "kind": "field", "filter_operators": [ "eq", "gt", "gte", "lt", "lte", "between", "empty", "not_empty" ] }, "title": { "kind": "field", "default": true, "nested_default": true }, "speaker": { "kind": "field", "default": true, "nested_default": true }, "start_time": { "kind": "field", "default": true, "nested_default": true }, "end_time": { "kind": "field", "default": true, "nested_default": true } }, "title": "DiscoveryAnnotation", "description": "Default fields: id, type, title, text, speaker, start_time, end_time" }, "CustomFields": { "type": "object", "description": "Custom field values. Property names are custom field definition keys, and each value is one of the supported formats below, depending on the field type. Omitted unless requested with the fields parameter or submitted in the request. Fields with no stored value are omitted.", "additionalProperties": { "x-additionalPropertiesName": "custom field definition key", "anyOf": [ { "title": "Text field", "type": "string", "description": "Returned for text fields." }, { "title": "Note field", "type": "string", "description": "Returned for note fields, as HTML. An empty note is returned as an empty string." }, { "title": "URL field", "type": "string", "format": "uri", "description": "Returned for URL fields." }, { "title": "Number field", "type": "string", "description": "Returned for number fields, as a decimal number encoded as a string (e.g. \"42.5\")." }, { "title": "Date field", "type": "string", "format": "date", "description": "Returned for date fields, formatted as YYYY-MM-DD." }, { "title": "Checkbox field", "type": "boolean", "description": "Returned for checkbox fields." }, { "title": "Single select field", "$ref": "#/components/schemas/CustomFieldOption", "description": "Returned for single select fields: the selected option." }, { "title": "Multi-select field", "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOption" }, "description": "Returned for multi-select fields: the selected options." }, { "title": "Conditional choice field", "type": "object", "properties": { "id": { "type": "string", "description": "ID of the selected option." }, "name": { "type": "string", "description": "Name of the selected option." }, "parents": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOption" }, "description": "Options above the selected option, from the top level down. Empty when the selected option is at the top level." } }, "description": "Returned for conditional choice fields: the selected option, which may be at any level, and the options above it." }, { "title": "Users field", "type": "array", "items": { "$ref": "#/components/schemas/User" }, "description": "Returned for users fields: the selected users." }, { "title": "Records field", "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldRecord" }, "description": "Returned for records fields other than users: the selected records." }, { "title": "Single custom table link", "$ref": "#/components/schemas/CustomFieldRecord", "description": "Returned for many-to-one custom table links: the selected accessible record. Fields without links are omitted, regardless of layout placement. An existing link to an inaccessible record returns null." }, { "title": "Custom table links", "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldRecord" }, "description": "Returned for many-to-many and master-detail custom table links: accessible linked records, ordered by ID. Fields without links are omitted, regardless of layout placement. Existing links to inaccessible records are excluded from the array." }, { "title": "Worksheet field", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the worksheet cell." }, "name": { "type": "string", "description": "Name of the worksheet cell." }, "format": { "type": "string", "enum": [ "string", "number", "percent", "currency", "date", "time", "boolean" ], "description": "Format of the cell's value." }, "computed": { "type": "boolean", "description": "Whether the cell is calculated from an equation. Computed cells can't be set." }, "value": { "type": [ "string", "boolean", "null" ], "description": "Value of the cell. Number, percent, and currency values are decimal numbers encoded as strings (e.g. \"42.5\"); percents are fractions (e.g. \"0.25\" for 25%). Date values are formatted as YYYY-MM-DD and time values as ISO 8601. Null when the cell has no value or has an error. \"[Hidden]\" when the value is calculated from records in workspaces you can't access." }, "error": { "type": [ "string", "null" ], "description": "Why the cell has no value, e.g. an input that isn't valid for the cell's format, or an equation that can't be calculated." } } }, "description": "Returned for worksheet fields: the worksheet's input and computed cells, in worksheet order. Sections are omitted." }, { "title": "Attachment field", "type": "array", "items": { "$ref": "#/components/schemas/Attachment" }, "description": "Returned for attachment fields: the attached files, in display order. Attachment fields are read-only." }, { "title": "Scorecard field", "type": "object", "properties": { "score": { "type": [ "number", "null" ], "description": "Total score of the scorecard. Calculated from the score facts unless set directly; null when it hasn't been calculated or set." }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFact" }, "description": "Metric values of the scorecard." } }, "description": "Returned for scorecard fields: the total score and the individual metric values." }, { "title": "No value", "type": "null", "description": "Returned for text, URL, number, date, checkbox, single select, and conditional choice fields that have no value, or a many-to-one custom table link to an inaccessible record." } ] } }, "CustomFieldsInput": { "type": "object", "description": "Custom field values to set. Property names are custom field definition keys, and each value is one of the supported input formats below, depending on the field type. Attachment fields are read-only and can't be set.", "additionalProperties": { "x-additionalPropertiesName": "custom field definition key", "anyOf": [ { "title": "Text field", "type": "string", "description": "Use for text fields." }, { "title": "Note field", "type": "string", "description": "Use for note fields, as HTML. The HTML may be normalized by the editor after it is saved, so a later read may return different HTML than was sent." }, { "title": "URL field", "type": "string", "format": "uri", "description": "Use for URL fields." }, { "title": "Number field", "type": "string", "description": "Use for number fields, as a decimal number encoded as a string (e.g. \"42.5\")." }, { "title": "Date field", "type": "string", "format": "date", "description": "Use for date fields, formatted as YYYY-MM-DD." }, { "title": "Checkbox field", "type": "boolean", "description": "Use for checkbox fields." }, { "title": "Single select field", "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the option. Will take precedence over the name if both are provided." }, "name": { "type": "string", "description": "Name of the option, matched exactly and case-sensitively." } }, "minProperties": 1, "description": "Use for single select fields: the option to select, identified by `id` or `name`. If both are provided, `id` takes precedence. Unknown keys are ignored." }, { "title": "Conditional choice field", "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the option." } }, "required": [ "id" ], "description": "Use for conditional choice fields: the option to select, identified by `id`. An option at any level can be selected. Options can't be matched by name, and other keys are ignored." }, { "title": "Multi-select field", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the option. Will take precedence over the name if both are provided." }, "name": { "type": "string", "description": "Name of the option, matched exactly and case-sensitively." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id` or `name`. A key whose value is null, or a string that is empty or only whitespace, counts as missing. If an item has more than one, `id` takes precedence when present and not missing, and the others are ignored." }, "description": "Use for multi-select fields. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing." }, { "title": "Records field", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the record." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id`. A key whose value is null, or a string that is empty or only whitespace, counts as missing." }, "description": "Use for records fields, including users fields. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing." }, { "title": "Single custom table link", "type": "object", "properties": { "id": { "type": "string", "description": "ID of an existing custom table record." } }, "required": [ "id" ], "description": "Use for many-to-one custom table links: replaces the selection with an existing accessible record identified by `id`. Send null to clear the link. Other keys are ignored. Create records separately." }, { "title": "Custom table links", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of an existing custom table record." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id`. A key whose value is null, or a string that is empty or only whitespace, counts as missing." }, "description": "Use for many-to-many and master-detail custom table links. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing. Removing a link does not delete the custom table record. Create records separately." }, { "title": "Worksheet field", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the worksheet cell." }, "value": { "type": [ "string", "number", "boolean", "null" ], "description": "New value for the cell, or null to clear it." } }, "required": [ "id", "value" ] }, "description": "Use for worksheet fields: sets input cells by `id`. Cells not listed are left unchanged, and computed cells are recalculated. Computed cells can't be set, and cells can't be removed with `_destroy`. A value that isn't valid for the cell's format is stored as the cell's `error`." }, { "title": "Scorecard field", "type": "object", "properties": { "score": { "type": [ "number", "null" ], "description": "Total score to set, or null to clear it. Replaced by the calculated score when score_facts are also sent, and on the next recalculation." }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactItemInput" }, "description": "Metric values to set. Metrics must belong to the field's scorecard. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing." } }, "minProperties": 1, "description": "Use for scorecard fields: sets the total score, the score facts, or both. Other keys are ignored." }, { "title": "Clear value", "type": "null", "description": "Clears a single value, note, conditional choice, or many-to-one custom table link field. Multi-select, records, many-to-many and master-detail custom table link, worksheet, and scorecard fields can't be cleared with null." } ] } }, "PaginationMeta": { "type": "object", "properties": { "has_more": { "type": "boolean", "description": "True if more records exist beyond this page" }, "next_cursor": { "type": [ "string", "null" ], "description": "Opaque cursor for the next page, null when no more records" }, "next_url": { "type": [ "string", "null" ], "format": "uri", "description": "Full URL for the next page, null when no more records" }, "truncated": { "type": "boolean", "description": "Only present when sorting. True if records exist beyond the 1,000 record sort limit." }, "truncated_message": { "type": "string", "description": "Only present when truncated is true. Explains the limit." } }, "required": [ "has_more" ] }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer", "description": "HTTP status code" }, "code": { "type": "string", "description": "Machine-readable error code (e.g., record.not_found)" }, "message": { "type": "string", "description": "Human-readable error message" }, "request_id": { "type": "string", "description": "Unique request identifier for tracing" } }, "required": [ "status", "code", "message", "request_id" ] } } }, "ValidationError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 422 ] }, "code": { "type": "string", "enum": [ "record.validation_failed", "record.cannot_delete" ] }, "message": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "The field that failed validation" }, "message": { "type": "string", "description": "Human-readable validation message" }, "code": { "type": "string", "description": "Validation error type (e.g., blank, too_long)" } } } }, "request_id": { "type": "string" } }, "required": [ "status", "code", "message", "details", "request_id" ] } } }, "GoalCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "effort": { "type": "integer", "description": "Estimated effort, from 0 to 100.", "x-aha-response-field": "effort" }, "value": { "type": "integer", "description": "Estimated value, from 0 to 100.", "x-aha-response-field": "value" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_initiatives", "from_initiatives_with_dependents", "from_descendants", "from_descendants_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_key_results", "from_key_results_with_dependents" ], "description": "Method used to calculate goal progress.", "x-aha-response-field": "progress_source" }, "success_metric_name": { "type": "string", "description": "Name of the goal's success metric.", "x-aha-response-field": "success_metric_name" }, "success_metric_description": { "type": "string", "description": "HTML description of the goal's success metric.", "x-aha-response-field": "success_metric_description" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "time_frame_id": { "type": "string", "description": "ID of the time frame assigned to the record.", "x-aha-response-field": "time_frame" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } }, "required": [ "project_id" ] } } }, "GoalUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "effort": { "type": "integer", "description": "Estimated effort, from 0 to 100.", "x-aha-response-field": "effort" }, "value": { "type": "integer", "description": "Estimated value, from 0 to 100.", "x-aha-response-field": "value" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_initiatives", "from_initiatives_with_dependents", "from_descendants", "from_descendants_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_key_results", "from_key_results_with_dependents" ], "description": "Method used to calculate goal progress.", "x-aha-response-field": "progress_source" }, "success_metric_name": { "type": "string", "description": "Name of the goal's success metric.", "x-aha-response-field": "success_metric_name" }, "success_metric_description": { "type": "string", "description": "HTML description of the goal's success metric.", "x-aha-response-field": "success_metric_description" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "time_frame_id": { "type": "string", "description": "ID of the time frame assigned to the record.", "x-aha-response-field": "time_frame" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } }, "ScoreFactItemInput": { "type": "object", "properties": { "scoring_system_metric_id": { "type": "string", "description": "Numeric ID of the scoring system metric. Required." }, "value": { "type": "number", "description": "Value to set for the metric. Updates the score fact's value; required unless _destroy is true." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `scoring_system_metric_id` or `value`. A key whose value is null, or a string that is empty or only whitespace, counts as missing. If an item has more than one, `scoring_system_metric_id` takes precedence when present and not missing, and the others are ignored." }, "WatcherItemInput": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the user to add or remove as a watcher. Required." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id`. A key whose value is null, or a string that is empty or only whitespace, counts as missing." }, "InitiativeCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_children", "from_children_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents" ], "description": "How progress is calculated for the initiative.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_children", "from_releases", "from_features_epics" ], "description": "How start and end dates are calculated for the initiative.", "x-aha-response-field": "duration_source" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "score": { "type": "number", "description": "Score assigned to the record.", "x-aha-response-field": "score" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "effort": { "type": "integer", "description": "Effort value of the initiative, from 0 to 100.", "x-aha-response-field": "effort" }, "value": { "type": "integer", "description": "Value of the initiative, from 0 to 100.", "x-aha-response-field": "value" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "time_frame_id": { "type": "string", "description": "ID of the time frame assigned to the record.", "x-aha-response-field": "time_frame" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactItemInput" }, "description": "Individual metric values for the initiative's scorecards. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "score_facts" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } }, "required": [ "project_id" ] } } }, "InitiativeUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_releases", "from_releases_with_dependents", "from_children", "from_children_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents" ], "description": "How progress is calculated for the initiative.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_children", "from_releases", "from_features_epics" ], "description": "How start and end dates are calculated for the initiative.", "x-aha-response-field": "duration_source" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "score": { "type": "number", "description": "Score assigned to the record.", "x-aha-response-field": "score" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "effort": { "type": "integer", "description": "Effort value of the initiative, from 0 to 100.", "x-aha-response-field": "effort" }, "value": { "type": "integer", "description": "Value of the initiative, from 0 to 100.", "x-aha-response-field": "value" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "time_frame_id": { "type": "string", "description": "ID of the time frame assigned to the record.", "x-aha-response-field": "time_frame" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactItemInput" }, "description": "Individual metric values for the initiative's scorecards. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "score_facts" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" } } } } }, "CompetitorCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "subtitle": { "type": "string", "description": "Subtitle of the competitor.", "x-aha-response-field": "subtitle" }, "website": { "type": "string", "description": "Website of the competitor.", "x-aha-response-field": "website" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } }, "required": [ "project_id" ] } } }, "CompetitorUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "subtitle": { "type": "string", "description": "Subtitle of the competitor.", "x-aha-response-field": "subtitle" }, "website": { "type": "string", "description": "Website of the competitor.", "x-aha-response-field": "website" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } }, "PersonaCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "occupation": { "type": "string", "description": "Occupation of the persona.", "x-aha-response-field": "occupation" }, "quote": { "type": "string", "description": "Quote from the persona.", "x-aha-response-field": "quote" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } }, "required": [ "project_id" ] } } }, "PersonaUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "occupation": { "type": "string", "description": "Occupation of the persona.", "x-aha-response-field": "occupation" }, "quote": { "type": "string", "description": "Quote from the persona.", "x-aha-response-field": "quote" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } }, "TagCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "type": { "type": "string", "enum": [ "general", "research" ], "description": "Type of the tag. research requires Aha! Discovery.", "x-aha-response-field": "type" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" } }, "required": [ "name" ] } } }, "TagUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "type": { "type": "string", "enum": [ "general", "research" ], "description": "Type of the tag. research requires Aha! Discovery.", "x-aha-response-field": "type" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" } } } } }, "IterationCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "status": { "type": "string", "description": "Status of the iteration.", "x-aha-response-field": "status" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "duration": { "type": "integer", "description": "Duration of the iteration.", "x-aha-response-field": "duration" }, "goal": { "type": "string", "description": "Goal of the iteration.", "x-aha-response-field": "goal" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } }, "required": [ "project_id" ] } } }, "IterationUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "status": { "type": "string", "description": "Status of the iteration.", "x-aha-response-field": "status" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "duration": { "type": "integer", "description": "Duration of the iteration.", "x-aha-response-field": "duration" }, "goal": { "type": "string", "description": "Goal of the iteration.", "x-aha-response-field": "goal" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" } } } } }, "KeyResultCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "target_metric": { "type": "string", "description": "Target value of the key result's metric.", "x-aha-response-field": "target_metric" }, "starting_metric": { "type": "string", "description": "Starting value of the key result's metric.", "x-aha-response-field": "starting_metric" }, "current_metric": { "type": "string", "description": "Current value of the key result's metric.", "x-aha-response-field": "current_metric" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "goal_id": { "type": "string", "description": "ID of the goal that contains the key result.", "x-aha-response-field": "goal" } }, "required": [ "goal_id" ] } } }, "KeyResultUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "target_metric": { "type": "string", "description": "Target value of the key result's metric.", "x-aha-response-field": "target_metric" }, "starting_metric": { "type": "string", "description": "Starting value of the key result's metric.", "x-aha-response-field": "starting_metric" }, "current_metric": { "type": "string", "description": "Current value of the key result's metric.", "x-aha-response-field": "current_metric" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" } } } } }, "ReleaseCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "release_date": { "type": "string", "format": "date", "description": "Release date of the release.", "x-aha-response-field": "release_date" }, "released_on": { "type": "string", "format": "date", "description": "Date when the release was released.", "x-aha-response-field": "released_on" }, "development_started_on": { "type": "string", "format": "date", "description": "Date when development of the release started.", "x-aha-response-field": "development_started_on" }, "external_release_date": { "type": "string", "format": "date", "description": "External release date of the release.", "x-aha-response-field": "external_release_date" }, "external_date_resolution": { "type": "string", "enum": [ "sync", "exact", "week", "month", "quarter", "half", "year" ], "description": "Precision of the external release date.", "x-aha-response-field": "external_date_resolution" }, "parking_lot": { "type": "boolean", "description": "Whether the release is a parking lot.", "x-aha-response-field": "parking_lot" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_release_phases", "from_release_phases_with_dependents", "from_todos", "from_todos_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_sub_releases" ], "description": "How progress is calculated for the release.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_release_phases_features", "from_sub_releases" ], "description": "How start and end dates are calculated for the release.", "x-aha-response-field": "duration_source" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "owner_id": { "type": "string", "description": "ID of the owner associated with the release.", "x-aha-response-field": "owner" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "parent_id": { "type": "string", "description": "ID of the parent associated with the release.", "x-aha-response-field": "parent" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "type": { "type": "string", "enum": [ "release", "rollup_release" ], "description": "Type of the release.", "x-aha-response-field": "type" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } }, "required": [ "project_id" ] } } }, "ReleaseUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "release_date": { "type": "string", "format": "date", "description": "Release date of the release.", "x-aha-response-field": "release_date" }, "released_on": { "type": "string", "format": "date", "description": "Date when the release was released.", "x-aha-response-field": "released_on" }, "development_started_on": { "type": "string", "format": "date", "description": "Date when development of the release started.", "x-aha-response-field": "development_started_on" }, "external_release_date": { "type": "string", "format": "date", "description": "External release date of the release.", "x-aha-response-field": "external_release_date" }, "external_date_resolution": { "type": "string", "enum": [ "sync", "exact", "week", "month", "quarter", "half", "year" ], "description": "Precision of the external release date.", "x-aha-response-field": "external_date_resolution" }, "parking_lot": { "type": "boolean", "description": "Whether the release is a parking lot.", "x-aha-response-field": "parking_lot" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_release_phases", "from_release_phases_with_dependents", "from_todos", "from_todos_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_features_completed", "from_features_completed_with_dependents", "from_epics", "from_epics_with_dependents", "from_sub_releases" ], "description": "How progress is calculated for the release.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_release_phases_features", "from_sub_releases" ], "description": "How start and end dates are calculated for the release.", "x-aha-response-field": "duration_source" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "owner_id": { "type": "string", "description": "ID of the owner associated with the release.", "x-aha-response-field": "owner" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "parent_id": { "type": "string", "description": "ID of the parent associated with the release.", "x-aha-response-field": "parent" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" } } } } }, "ReleasePhaseCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "type": { "type": "string", "enum": [ "milestone", "phase" ], "description": "Type of the release phase.", "x-aha-response-field": "type" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the release phase.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "How start and end dates are calculated for the release phase.", "x-aha-response-field": "duration_source" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "release_id": { "type": "string", "description": "ID of the release associated with the record.", "x-aha-response-field": "release" } }, "required": [ "type", "release_id" ] } } }, "ReleasePhaseUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "type": { "type": "string", "enum": [ "milestone", "phase" ], "description": "Type of the release phase.", "x-aha-response-field": "type" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "color": { "type": "string", "description": "Color assigned to the record as a hex value.", "x-aha-response-field": "color" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the release phase.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "How start and end dates are calculated for the release phase.", "x-aha-response-field": "duration_source" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } }, "TagItemInput": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the tag. Will take precedence over the name if both are provided." }, "name": { "type": "string", "description": "Name of the tag, matched case-sensitively." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id` or `name`. A key whose value is null, or a string that is empty or only whitespace, counts as missing. If an item has more than one, `id` takes precedence when present and not missing, and the others are ignored." }, "GoalItemInput": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the goal. Will take precedence over the reference_num if both are provided." }, "reference_num": { "type": "string", "description": "Reference number of the goal, for example DEMO-G-1." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id` or `reference_num`. A key whose value is null, or a string that is empty or only whitespace, counts as missing. If an item has more than one, `id` takes precedence when present and not missing, and the others are ignored." }, "KeyResultItemInput": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the key result. Will take precedence over the reference_num if both are provided." }, "reference_num": { "type": "string", "description": "Reference number of the key result, for example DEMO-G-1-KR-1." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id` or `reference_num`. A key whose value is null, or a string that is empty or only whitespace, counts as missing. If an item has more than one, `id` takes precedence when present and not missing, and the others are ignored." }, "FeatureCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "score": { "type": "number", "description": "Score assigned to the record.", "x-aha-response-field": "score" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_requirements", "from_requirements_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents" ], "description": "How progress is calculated for the record.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_iterations", "from_releases", "from_requirements" ], "description": "How start and end dates are calculated for the record.", "x-aha-response-field": "duration_source" }, "estimate_source": { "type": "string", "enum": [ "manual", "from_requirements" ], "description": "Whether estimates are entered on the record or calculated from its requirements.", "x-aha-response-field": "estimate_source" }, "epic_id": { "type": "string", "description": "ID of the epic associated with the feature.", "x-aha-response-field": "epic" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "type_id": { "type": "string", "description": "ID of the type assigned to the record.", "x-aha-response-field": "type" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "created_by_user_id": { "type": "string", "description": "ID of the user who created the record.", "x-aha-response-field": "created_by_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "release_id": { "type": "string", "description": "ID of the release associated with the record.", "x-aha-response-field": "release" }, "release_phase_id": { "type": "string", "description": "ID of the release phase associated with the record.", "x-aha-response-field": "release_phase" }, "iteration_id": { "type": "string", "description": "ID of the iteration associated with the record.", "x-aha-response-field": "iteration" }, "initiative_id": { "type": "string", "description": "ID of the initiative associated with the record.", "x-aha-response-field": "initiative" }, "team_id": { "type": "string", "description": "ID of the team assigned to the record.", "x-aha-response-field": "team", "x-aha-conditional": true }, "team_status_id": { "type": "string", "description": "ID of the team status assigned to the record.", "x-aha-response-field": "team_status", "x-aha-conditional": true }, "program_increment_id": { "type": "string", "description": "ID of the program increment associated with the record.", "x-aha-response-field": "program_increment" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagItemInput" }, "description": "Tags associated with the feature. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "tags" }, "goals": { "type": "array", "items": { "$ref": "#/components/schemas/GoalItemInput" }, "description": "Goals associated with the feature. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "goals" }, "key_results": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultItemInput" }, "description": "Key results associated with the feature. Only available when key results are enabled for the account. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "key_results", "x-aha-conditional": true }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactItemInput" }, "description": "Individual metric values for the feature's scorecards. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "score_facts" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } } } } }, "FeatureUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "score": { "type": "number", "description": "Score assigned to the record.", "x-aha-response-field": "score" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_requirements", "from_requirements_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents" ], "description": "How progress is calculated for the record.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_iterations", "from_releases", "from_requirements" ], "description": "How start and end dates are calculated for the record.", "x-aha-response-field": "duration_source" }, "estimate_source": { "type": "string", "enum": [ "manual", "from_requirements" ], "description": "Whether estimates are entered on the record or calculated from its requirements.", "x-aha-response-field": "estimate_source" }, "epic_id": { "type": "string", "description": "ID of the epic associated with the feature.", "x-aha-response-field": "epic" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "type_id": { "type": "string", "description": "ID of the type assigned to the record.", "x-aha-response-field": "type" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "created_by_user_id": { "type": "string", "description": "ID of the user who created the record.", "x-aha-response-field": "created_by_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "release_id": { "type": "string", "description": "ID of the release associated with the record.", "x-aha-response-field": "release" }, "release_phase_id": { "type": "string", "description": "ID of the release phase associated with the record.", "x-aha-response-field": "release_phase" }, "iteration_id": { "type": "string", "description": "ID of the iteration associated with the record.", "x-aha-response-field": "iteration" }, "initiative_id": { "type": "string", "description": "ID of the initiative associated with the record.", "x-aha-response-field": "initiative" }, "team_id": { "type": "string", "description": "ID of the team assigned to the record.", "x-aha-response-field": "team", "x-aha-conditional": true }, "team_status_id": { "type": "string", "description": "ID of the team status assigned to the record.", "x-aha-response-field": "team_status", "x-aha-conditional": true }, "program_increment_id": { "type": "string", "description": "ID of the program increment associated with the record.", "x-aha-response-field": "program_increment" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagItemInput" }, "description": "Tags associated with the feature. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "tags" }, "goals": { "type": "array", "items": { "$ref": "#/components/schemas/GoalItemInput" }, "description": "Goals associated with the feature. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "goals" }, "key_results": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultItemInput" }, "description": "Key results associated with the feature. Only available when key results are enabled for the account. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "key_results", "x-aha-conditional": true }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactItemInput" }, "description": "Individual metric values for the feature's scorecards. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "score_facts" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } }, "EpicCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "score": { "type": "number", "description": "Score assigned to the record.", "x-aha-response-field": "score" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the record.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_features", "from_releases" ], "description": "How start and end dates are calculated for the record.", "x-aha-response-field": "duration_source" }, "estimate_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "Whether estimates are entered on the record or calculated from its features.", "x-aha-response-field": "estimate_source" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "created_by_user_id": { "type": "string", "description": "ID of the user who created the record.", "x-aha-response-field": "created_by_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "release_id": { "type": "string", "description": "ID of the release associated with the record.", "x-aha-response-field": "release" }, "release_phase_id": { "type": "string", "description": "ID of the release phase associated with the record.", "x-aha-response-field": "release_phase" }, "iteration_id": { "type": "string", "description": "ID of the iteration associated with the record.", "x-aha-response-field": "iteration" }, "initiative_id": { "type": "string", "description": "ID of the initiative associated with the record.", "x-aha-response-field": "initiative" }, "team_id": { "type": "string", "description": "ID of the team assigned to the record.", "x-aha-response-field": "team", "x-aha-conditional": true }, "team_status_id": { "type": "string", "description": "ID of the team status assigned to the record.", "x-aha-response-field": "team_status", "x-aha-conditional": true }, "program_increment_id": { "type": "string", "description": "ID of the program increment associated with the record.", "x-aha-response-field": "program_increment" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagItemInput" }, "description": "Tags associated with the epic. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "tags" }, "goals": { "type": "array", "items": { "$ref": "#/components/schemas/GoalItemInput" }, "description": "Goals associated with the epic. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "goals" }, "key_results": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultItemInput" }, "description": "Key results associated with the epic. Only available when key results are enabled for the account. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "key_results", "x-aha-conditional": true }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactItemInput" }, "description": "Individual metric values for the epic's scorecards. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "score_facts" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } } } } }, "EpicUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "progress": { "type": "number", "description": "Progress completed for the record.", "x-aha-response-field": "progress" }, "score": { "type": "number", "description": "Score assigned to the record.", "x-aha-response-field": "score" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "progress_source": { "type": "string", "enum": [ "manual", "from_features", "from_features_with_dependents", "from_remaining_estimate", "from_remaining_estimate_with_dependents", "from_todos", "from_todos_with_dependents", "from_features_completed", "from_features_completed_with_dependents" ], "description": "How progress is calculated for the record.", "x-aha-response-field": "progress_source" }, "duration_source": { "type": "string", "enum": [ "manual", "from_features", "from_releases" ], "description": "How start and end dates are calculated for the record.", "x-aha-response-field": "duration_source" }, "estimate_source": { "type": "string", "enum": [ "manual", "from_features" ], "description": "Whether estimates are entered on the record or calculated from its features.", "x-aha-response-field": "estimate_source" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "created_by_user_id": { "type": "string", "description": "ID of the user who created the record.", "x-aha-response-field": "created_by_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "release_id": { "type": "string", "description": "ID of the release associated with the record.", "x-aha-response-field": "release" }, "release_phase_id": { "type": "string", "description": "ID of the release phase associated with the record.", "x-aha-response-field": "release_phase" }, "iteration_id": { "type": "string", "description": "ID of the iteration associated with the record.", "x-aha-response-field": "iteration" }, "initiative_id": { "type": "string", "description": "ID of the initiative associated with the record.", "x-aha-response-field": "initiative" }, "team_id": { "type": "string", "description": "ID of the team assigned to the record.", "x-aha-response-field": "team", "x-aha-conditional": true }, "team_status_id": { "type": "string", "description": "ID of the team status assigned to the record.", "x-aha-response-field": "team_status", "x-aha-conditional": true }, "program_increment_id": { "type": "string", "description": "ID of the program increment associated with the record.", "x-aha-response-field": "program_increment" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagItemInput" }, "description": "Tags associated with the epic. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "tags" }, "goals": { "type": "array", "items": { "$ref": "#/components/schemas/GoalItemInput" }, "description": "Goals associated with the epic. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "goals" }, "key_results": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultItemInput" }, "description": "Key results associated with the epic. Only available when key results are enabled for the account. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "key_results", "x-aha-conditional": true }, "score_facts": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactItemInput" }, "description": "Individual metric values for the epic's scorecards. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "score_facts" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" } } } } }, "RequirementCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "feature_id": { "type": "string", "description": "ID of the feature associated with the requirement.", "x-aha-response-field": "feature" }, "iteration_id": { "type": "string", "description": "ID of the iteration associated with the record.", "x-aha-response-field": "iteration" }, "created_by_user_id": { "type": "string", "description": "ID of the user who created the record.", "x-aha-response-field": "created_by_user" }, "team_id": { "type": "string", "description": "ID of the team assigned to the record.", "x-aha-response-field": "team", "x-aha-conditional": true }, "team_status_id": { "type": "string", "description": "ID of the team status assigned to the record.", "x-aha-response-field": "team_status", "x-aha-conditional": true }, "program_increment_id": { "type": "string", "description": "ID of the program increment associated with the record.", "x-aha-response-field": "program_increment" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagItemInput" }, "description": "Tags associated with the requirement. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "tags" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } }, "required": [ "feature_id" ] } } }, "RequirementUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "initial_estimate": { "type": "number", "description": "Initial work estimate for the record.", "x-aha-response-field": "initial_estimate" }, "detailed_estimate": { "type": "number", "description": "Detailed work estimate for the record.", "x-aha-response-field": "detailed_estimate" }, "remaining_estimate": { "type": "number", "description": "Remaining work estimate for the record.", "x-aha-response-field": "remaining_estimate" }, "work_done": { "type": "number", "description": "Work completed for the record.", "x-aha-response-field": "work_done" }, "status_id": { "type": "string", "description": "ID of the status assigned to the record.", "x-aha-response-field": "status" }, "assigned_to_user_id": { "type": "string", "description": "ID of the user assigned to the record.", "x-aha-response-field": "assigned_to_user" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "feature_id": { "type": "string", "description": "ID of the feature associated with the requirement.", "x-aha-response-field": "feature" }, "iteration_id": { "type": "string", "description": "ID of the iteration associated with the record.", "x-aha-response-field": "iteration" }, "created_by_user_id": { "type": "string", "description": "ID of the user who created the record.", "x-aha-response-field": "created_by_user" }, "team_id": { "type": "string", "description": "ID of the team assigned to the record.", "x-aha-response-field": "team", "x-aha-conditional": true }, "team_status_id": { "type": "string", "description": "ID of the team status assigned to the record.", "x-aha-response-field": "team_status", "x-aha-conditional": true }, "program_increment_id": { "type": "string", "description": "ID of the program increment associated with the record.", "x-aha-response-field": "program_increment" }, "time_code_id": { "type": "string", "description": "ID of the time code assigned to the record. only available when timesheets are enabled for the account.", "x-aha-response-field": "time_code", "x-aha-conditional": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagItemInput" }, "description": "Tags associated with the requirement. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "tags" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } }, "TaskAssignmentItemInput": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the assigned user, approval group, or workspace." }, "type": { "type": "string", "description": "Type of the assigned record.", "enum": [ "user", "approval_group", "project" ] }, "status": { "type": "string", "enum": [ "pending", "completed", "approved", "approved_conditionally", "rejected", "skipped" ] }, "_destroy": { "type": "boolean", "description": "Remove the assignment identified by id and type." } }, "required": [ "id", "type" ] }, "TaskCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "type": { "type": "string", "enum": [ "task", "approval", "work_request" ], "description": "Type of the task.", "x-aha-response-field": "type" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "due_date": { "type": "string", "format": "date", "description": "Due date of the record.", "x-aha-response-field": "due_date" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "record_id": { "type": [ "string", "null" ], "description": "ID or reference number of the record. Supply with record_type; set both to null to clear the association.", "x-aha-response-field": "record" }, "record_type": { "type": [ "string", "null" ], "description": "Record type of the record, as returned by record.type. Supply with record_id.", "enum": [ "business_model", "competitor", "creative_brief", "epic", "feature", "feedback_campaign", "idea", "empathy_session", "idea_theme", "poll", "initiative", "iteration", "document", "vision_component", "persona", "program_increment", "project", "vision", "notebook", "release", "release_phase", "requirement", "goal", "goals_chart", "key_result", "interview", "study", "presentation", null ], "x-aha-response-field": "record" }, "assigned_to": { "type": "array", "description": "Provide the assigned record's id and type to add an assignment or update its status. Set _destroy to true to remove it. Omitted assignments remain unchanged.", "items": { "$ref": "#/components/schemas/TaskAssignmentItemInput" }, "x-aha-response-field": "assigned_to" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } }, "dependentRequired": { "record_id": [ "record_type" ], "record_type": [ "record_id" ] } } } }, "TaskUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "type": { "type": "string", "enum": [ "task", "approval", "work_request" ], "description": "Type of the task.", "x-aha-response-field": "type" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "due_date": { "type": "string", "format": "date", "description": "Due date of the record.", "x-aha-response-field": "due_date" }, "position": { "type": "integer", "description": "Position of the record relative to its siblings.", "x-aha-response-field": "position" }, "record_id": { "type": [ "string", "null" ], "description": "ID or reference number of the record. Supply with record_type; set both to null to clear the association.", "x-aha-response-field": "record" }, "record_type": { "type": [ "string", "null" ], "description": "Record type of the record, as returned by record.type. Supply with record_id.", "enum": [ "business_model", "competitor", "creative_brief", "epic", "feature", "feedback_campaign", "idea", "empathy_session", "idea_theme", "poll", "initiative", "iteration", "document", "vision_component", "persona", "program_increment", "project", "vision", "notebook", "release", "release_phase", "requirement", "goal", "goals_chart", "key_result", "interview", "study", "presentation", null ], "x-aha-response-field": "record" }, "assigned_to": { "type": "array", "description": "Provide the assigned record's id and type to add an assignment or update its status. Set _destroy to true to remove it. Omitted assignments remain unchanged.", "items": { "$ref": "#/components/schemas/TaskAssignmentItemInput" }, "x-aha-response-field": "assigned_to" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } }, "dependentRequired": { "record_id": [ "record_type" ], "record_type": [ "record_id" ] } } } }, "ProjectCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "reference_prefix": { "type": "string", "description": "Reference prefix of the project.", "x-aha-response-field": "reference_prefix" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "parent_id": { "type": "string", "description": "ID of the parent associated with the project.", "x-aha-response-field": "parent" } }, "required": [ "name", "reference_prefix" ] } } }, "ProjectUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "reference_prefix": { "type": "string", "description": "Reference prefix of the project.", "x-aha-response-field": "reference_prefix" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "watchers": { "type": "array", "items": { "$ref": "#/components/schemas/WatcherItemInput" }, "description": "Users watching the record for update notifications. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "watchers" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "parent_id": { "type": "string", "description": "ID of the parent associated with the project.", "x-aha-response-field": "parent" } } } } }, "LayoutItemInput": { "type": "object", "properties": { "id": { "type": "string", "description": "Numeric ID of the layout to add the field to or remove it from. Required." }, "_destroy": { "type": "boolean", "description": "Set to true to remove this record from the collection. Removing a record that is not linked does nothing." } }, "description": "Identifies a record by `id`. A key whose value is null, or a string that is empty or only whitespace, counts as missing." }, "WorksheetRowItemInput": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of an existing row to update or remove. Omit to add a new row at the end." }, "type": { "type": "string", "description": "Whether the row is a field or a section heading. Required for new rows; cannot be changed.", "enum": [ "field", "section" ] }, "name": { "type": "string", "description": "Name of the field, or the text of the section heading." }, "equation": { "type": "string", "description": "Value or equation of a field row." }, "format": { "type": "string", "description": "Value format of a field row. New field rows default to number.", "enum": [ "string", "number", "percent", "currency", "date", "boolean" ] }, "precision": { "type": "integer", "description": "Decimal places (0, 1, 2) of a number or percent row." }, "show_thousand_separator": { "type": "boolean", "description": "Whether a number or percent row shows thousands separators." }, "currency": { "type": "string", "description": "Currency of a currency row.", "enum": [ "us_dollar", "euro", "pound", "yen" ] }, "date_format": { "type": "string", "description": "Date format of a date row.", "enum": [ "american", "standard", "computer", "month", "full_text_month_year", "abbrev_text_month_year" ] }, "_destroy": { "type": "boolean", "description": "Remove the row identified by id." } }, "required": [] }, "CustomFieldDefinitionCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the custom field definition.", "x-aha-response-field": "name" }, "internal_name": { "type": "string", "description": "Internal name of the custom field definition, shown only to administrators.", "x-aha-response-field": "internal_name" }, "key": { "type": "string", "description": "Key of the custom field definition. Must be unique per record type and only use lowercase letters, numbers and underscores.", "x-aha-response-field": "key" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "layouts": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutItemInput" }, "description": "Layouts the custom field definition appears on. Not settable for account-level or custom table fields, which have no layouts to choose. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "layouts" }, "prefix": { "type": "string", "description": "Text shown before the value of a number field. Null for other types.", "x-aha-response-field": "prefix" }, "suffix": { "type": "string", "description": "Text shown after the value of a number field. Null for other types.", "x-aha-response-field": "suffix" }, "use_delimiters": { "type": "boolean", "description": "Whether a number field shows thousands separators. Always false for other types.", "x-aha-response-field": "use_delimiters" }, "label": { "type": "string", "description": "Label shown next to a checkbox field. Null for other types.", "x-aha-response-field": "label" }, "display": { "type": "string", "enum": [ "plain_text", "colored_labels" ], "description": "How a predefined or editable choice list field shows its value. Null for other types.", "x-aha-response-field": "display" }, "scope": { "type": "string", "enum": [ "account", "project_line", "project", "related" ], "description": "Which records a records field offers as values: all in the account, those in the record's workspace line or workspace, or those related to the record. The scopes available depend on the field type and record type. Null for other types.", "x-aha-response-field": "scope" }, "supported_file_types": { "type": "array", "items": { "type": "string" }, "description": "File extensions an attachment field accepts, from: csv, doc, docx, eml, gif, jpeg, mov, mp4, msg, pdf, png, ppt, pptx, tiff, txt, xls, xlsx. Null or empty allows every file type. Null for other types.", "x-aha-response-field": "supported_file_types" }, "linked_custom_table_id": { "type": "string", "description": "ID of the custom table a relationship field links to; set on create only and null for other types.", "x-aha-response-field": "linked_custom_table" }, "project_scope": { "type": "string", "enum": [ "account", "project" ], "description": "Which custom table records a many to many or many to one relationship field offers: all in the account, or those in the record's workspace and its parent lines. Idea organization fields only support account. Null for other types.", "x-aha-response-field": "project_scope" }, "scoring_system_id": { "type": "string", "description": "ID of the account scorecard a scorecard field uses; required for scorecard fields and null for other types.", "x-aha-response-field": "scoring_system" }, "worksheet_rows": { "type": "array", "description": "Rows of a worksheet field. Send a row's id to update the fields you provide, omit the id to add a row at the end, or set _destroy to true to remove a row. Rows you don't send remain unchanged.", "items": { "$ref": "#/components/schemas/WorksheetRowItemInput" }, "x-aha-response-field": "worksheet_rows" }, "type": { "type": "string", "enum": [ "text", "note", "number", "date", "url", "checkbox", "attachment", "predefined_choice_list", "editable_choice_list", "predefined_tags", "tags", "conditional_choice", "scorecard", "worksheet", "many_to_many_relationship", "many_to_one_relationship", "one_to_many_relationship", "users", "workspaces", "goals", "initiatives", "key_results", "releases", "epics", "features", "ideas", "idea_categories", "organizations", "idea_created_by", "competitors", "personas", "creative_briefs" ], "description": "Type of the custom field definition.", "x-aha-response-field": "type" }, "record_type": { "type": "string", "enum": [ "project", "feature", "epic", "requirement", "release", "release_phase", "initiative", "goal", "key_result", "idea", "idea_endorsement", "idea_organization", "idea_user", "creative_brief", "persona", "competitor", "capacity_investment", "team", "program_increment", "task", "document", "study", "interview", "custom_table" ], "description": "Record type the custom field definition belongs to. Custom table fields use custom_table.", "x-aha-response-field": "record_type" }, "custom_table_id": { "type": "string", "description": "ID of the custom table the custom field definition belongs to if record_type is custom_table.", "x-aha-response-field": "custom_table" } }, "required": [ "name", "key", "type", "record_type" ] } } }, "CustomFieldDefinitionUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the custom field definition.", "x-aha-response-field": "name" }, "internal_name": { "type": "string", "description": "Internal name of the custom field definition, shown only to administrators.", "x-aha-response-field": "internal_name" }, "key": { "type": "string", "description": "Key of the custom field definition. Must be unique per record type and only use lowercase letters, numbers and underscores.", "x-aha-response-field": "key" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "layouts": { "type": "array", "items": { "$ref": "#/components/schemas/LayoutItemInput" }, "description": "Layouts the custom field definition appears on. Not settable for account-level or custom table fields, which have no layouts to choose. Items are merged into the existing collection: each item adds a record, or removes it with `_destroy: true`. Records not listed are left unchanged, and an empty array changes nothing.", "x-aha-response-field": "layouts" }, "prefix": { "type": "string", "description": "Text shown before the value of a number field. Null for other types.", "x-aha-response-field": "prefix" }, "suffix": { "type": "string", "description": "Text shown after the value of a number field. Null for other types.", "x-aha-response-field": "suffix" }, "use_delimiters": { "type": "boolean", "description": "Whether a number field shows thousands separators. Always false for other types.", "x-aha-response-field": "use_delimiters" }, "label": { "type": "string", "description": "Label shown next to a checkbox field. Null for other types.", "x-aha-response-field": "label" }, "display": { "type": "string", "enum": [ "plain_text", "colored_labels" ], "description": "How a predefined or editable choice list field shows its value. Null for other types.", "x-aha-response-field": "display" }, "scope": { "type": "string", "enum": [ "account", "project_line", "project", "related" ], "description": "Which records a records field offers as values: all in the account, those in the record's workspace line or workspace, or those related to the record. The scopes available depend on the field type and record type. Null for other types.", "x-aha-response-field": "scope" }, "supported_file_types": { "type": "array", "items": { "type": "string" }, "description": "File extensions an attachment field accepts, from: csv, doc, docx, eml, gif, jpeg, mov, mp4, msg, pdf, png, ppt, pptx, tiff, txt, xls, xlsx. Null or empty allows every file type. Null for other types.", "x-aha-response-field": "supported_file_types" }, "linked_custom_table_id": { "type": "string", "description": "ID of the custom table a relationship field links to; set on create only and null for other types.", "x-aha-response-field": "linked_custom_table" }, "project_scope": { "type": "string", "enum": [ "account", "project" ], "description": "Which custom table records a many to many or many to one relationship field offers: all in the account, or those in the record's workspace and its parent lines. Idea organization fields only support account. Null for other types.", "x-aha-response-field": "project_scope" }, "scoring_system_id": { "type": "string", "description": "ID of the account scorecard a scorecard field uses; required for scorecard fields and null for other types.", "x-aha-response-field": "scoring_system" }, "worksheet_rows": { "type": "array", "description": "Rows of a worksheet field. Send a row's id to update the fields you provide, omit the id to add a row at the end, or set _destroy to true to remove a row. Rows you don't send remain unchanged.", "items": { "$ref": "#/components/schemas/WorksheetRowItemInput" }, "x-aha-response-field": "worksheet_rows" } } } } }, "CustomFieldOptionCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the option.", "x-aha-response-field": "name" }, "color": { "type": "string", "description": "Color of the option as a hex value.", "x-aha-response-field": "color" }, "hidden": { "type": "boolean", "description": "Whether the option is hidden from selection. Hidden options remain on records that already use them.", "x-aha-response-field": "hidden" }, "position": { "type": "integer", "description": "Position of the option among its siblings. Options of conditional choice fields are ordered under their parent.", "x-aha-response-field": "position" }, "parent_id": { "type": "string", "description": "ID of the parent option of a conditional choice field option; set on create only and null for other options.", "x-aha-response-field": "parent_id" }, "custom_field_definition_id": { "type": "string", "description": "ID of the choice custom field definition that owns the option.", "x-aha-response-field": "custom_field_definition" } }, "required": [ "name", "custom_field_definition_id" ] } } }, "CustomFieldOptionUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the option.", "x-aha-response-field": "name" }, "color": { "type": "string", "description": "Color of the option as a hex value.", "x-aha-response-field": "color" }, "hidden": { "type": "boolean", "description": "Whether the option is hidden from selection. Hidden options remain on records that already use them.", "x-aha-response-field": "hidden" }, "position": { "type": "integer", "description": "Position of the option among its siblings. Options of conditional choice fields are ordered under their parent.", "x-aha-response-field": "position" }, "parent_id": { "type": "string", "description": "ID of the parent option of a conditional choice field option; set on create only and null for other options.", "x-aha-response-field": "parent_id" } } } } }, "AutomationCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "trigger_kind": { "type": "string", "enum": [ "field_changed", "record_created", "delayed_field_changed" ], "description": "Trigger kind of the automation.", "x-aha-response-field": "trigger_kind" }, "trigger_field": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "score", "release", "watchers", "team", "iteration", "record_risk", "progress", "initial_estimate", "detailed_estimate", "record_links", "custom_field", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "duplicate_idea", "categories", "visibility", "num_endorsements", "num_organizations", "submitted_idea_portal", "parent", "collections", "task_status", "due_date", "approval_groups", "assignees" ], "description": "The field that will cause the automation to trigger for field_changed automations.", "x-aha-response-field": "trigger_field" }, "custom_field_definition_id": { "type": "string", "description": "ID of the custom field definition id associated with the automation if trigger_field is custom_field.", "x-aha-response-field": "custom_field_definition" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values that will be used to compare against the trigger field to determine if the automation should trigger.", "x-aha-response-field": "values" }, "change_type": { "type": "string", "enum": [ "specific", "any", "=", "add", "remove", ">", "<", "current", "present", "blank", "present_with_comment", "parking_lot", "non_parking_lot" ], "description": "The operation to use to determine if the automation should trigger.", "x-aha-response-field": "change_type" }, "link_filter_type": { "type": "string", "enum": [ "link_type", "linked_record", "linked_record_status" ], "description": "Additional field information when using the record_links trigger_field.", "x-aha-response-field": "link_filter_type" }, "field_worksheet_row": { "type": "string", "description": "The worksheet row of a worksheet custom field if applicable.", "x-aha-response-field": "field_worksheet_row" }, "enabled": { "type": "boolean", "description": "Whether the automation is enabled.", "x-aha-response-field": "enabled" }, "trigger_conditions": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/AutomationTriggerConditionConfig" } ] }, "description": "A list of additional conditions that must be met for the automation to trigger.", "x-aha-response-field": "trigger_conditions" }, "trigger_record_type": { "type": "string", "enum": [ "feature", "release", "release_phase", "epic", "requirement", "idea", "initiative", "goal", "key_result", "task", "approval", "work_request", "document" ], "description": "What record type the automation is for.", "x-aha-response-field": "trigger_record_type" }, "custom_table_id": { "type": "string", "description": "ID of the custom table id associated with the automation if trigger_record_type is custom_table.", "x-aha-response-field": "custom_table" }, "project_id": { "type": "string", "description": "ID of the workspace on which the automation runs.", "x-aha-response-field": "automatable" } }, "required": [ "trigger_record_type" ] } } }, "AutomationUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "trigger_kind": { "type": "string", "enum": [ "field_changed", "record_created", "delayed_field_changed" ], "description": "Trigger kind of the automation.", "x-aha-response-field": "trigger_kind" }, "trigger_field": { "type": "string", "enum": [ "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "score", "release", "watchers", "team", "iteration", "record_risk", "progress", "initial_estimate", "detailed_estimate", "record_links", "custom_field", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "duplicate_idea", "categories", "visibility", "num_endorsements", "num_organizations", "submitted_idea_portal", "parent", "collections", "task_status", "due_date", "approval_groups", "assignees" ], "description": "The field that will cause the automation to trigger for field_changed automations.", "x-aha-response-field": "trigger_field" }, "custom_field_definition_id": { "type": "string", "description": "ID of the custom field definition id associated with the automation if trigger_field is custom_field.", "x-aha-response-field": "custom_field_definition" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Values that will be used to compare against the trigger field to determine if the automation should trigger.", "x-aha-response-field": "values" }, "change_type": { "type": "string", "enum": [ "specific", "any", "=", "add", "remove", ">", "<", "current", "present", "blank", "present_with_comment", "parking_lot", "non_parking_lot" ], "description": "The operation to use to determine if the automation should trigger.", "x-aha-response-field": "change_type" }, "link_filter_type": { "type": "string", "enum": [ "link_type", "linked_record", "linked_record_status" ], "description": "Additional field information when using the record_links trigger_field.", "x-aha-response-field": "link_filter_type" }, "field_worksheet_row": { "type": "string", "description": "The worksheet row of a worksheet custom field if applicable.", "x-aha-response-field": "field_worksheet_row" }, "enabled": { "type": "boolean", "description": "Whether the automation is enabled.", "x-aha-response-field": "enabled" }, "trigger_conditions": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/AutomationTriggerConditionConfig" } ] }, "description": "A list of additional conditions that must be met for the automation to trigger.", "x-aha-response-field": "trigger_conditions" } } } } }, "AutomationActionCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/AutomationUpdateFieldConfig", "description": "Configuration for update_field and update_related_field actions.", "x-aha-response-field": "field" }, "comment": { "$ref": "#/components/schemas/AutomationCreateCommentConfig", "description": "Configuration for create_comment and create_idea_admin_response actions.", "x-aha-response-field": "comment" }, "requirement": { "$ref": "#/components/schemas/AutomationCreateRequirementConfig", "description": "Configuration for create_requirement actions.", "x-aha-response-field": "requirement" }, "task": { "$ref": "#/components/schemas/AutomationCreateTaskConfig", "description": "Configuration for create_task actions.", "x-aha-response-field": "task" }, "document": { "$ref": "#/components/schemas/AutomationCreateDocumentConfig", "description": "Configuration for create_document actions.", "x-aha-response-field": "document" }, "custom_table_record": { "$ref": "#/components/schemas/AutomationCreateCustomTableRecordConfig", "description": "Configuration for create_custom_table_record actions.", "x-aha-response-field": "custom_table_record" }, "email": { "$ref": "#/components/schemas/AutomationSendEmailConfig", "description": "Configuration for send_email actions.", "x-aha-response-field": "email" }, "automation_id": { "type": "string", "description": "ID of the automation that owns the action.", "x-aha-response-field": "automation" }, "type": { "type": "string", "enum": [ "update_field", "update_related_field", "create_comment", "create_task", "create_requirement", "create_document", "create_custom_table_record", "send_email", "send_to_integration", "resend_to_integration", "create_idea_admin_response" ], "description": "Type of the automation action.", "x-aha-response-field": "type" } }, "required": [ "automation_id", "type" ] } } }, "AutomationActionUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/AutomationUpdateFieldConfig", "description": "Configuration for update_field and update_related_field actions.", "x-aha-response-field": "field" }, "comment": { "$ref": "#/components/schemas/AutomationCreateCommentConfig", "description": "Configuration for create_comment and create_idea_admin_response actions.", "x-aha-response-field": "comment" }, "requirement": { "$ref": "#/components/schemas/AutomationCreateRequirementConfig", "description": "Configuration for create_requirement actions.", "x-aha-response-field": "requirement" }, "task": { "$ref": "#/components/schemas/AutomationCreateTaskConfig", "description": "Configuration for create_task actions.", "x-aha-response-field": "task" }, "document": { "$ref": "#/components/schemas/AutomationCreateDocumentConfig", "description": "Configuration for create_document actions.", "x-aha-response-field": "document" }, "custom_table_record": { "$ref": "#/components/schemas/AutomationCreateCustomTableRecordConfig", "description": "Configuration for create_custom_table_record actions.", "x-aha-response-field": "custom_table_record" }, "email": { "$ref": "#/components/schemas/AutomationSendEmailConfig", "description": "Configuration for send_email actions.", "x-aha-response-field": "email" } } } } }, "DiscoveryInterviewCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview starts.", "x-aha-response-field": "start_time" }, "end_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview ends.", "x-aha-response-field": "end_time" }, "status": { "type": "string", "enum": [ "scheduling", "scheduled", "processing", "analyzing", "completed", "canceled" ], "description": "Status of the interview.", "x-aha-response-field": "status" }, "mode": { "type": "string", "enum": [ "in_person", "phone", "video", "focus_group", "observation", "document_analysis" ], "description": "Mode of the interview.", "x-aha-response-field": "mode" }, "study_id": { "type": "string", "description": "ID of the study containing the interview.", "x-aha-response-field": "study" }, "interview_type_id": { "type": "string", "description": "ID of the type of interview.", "x-aha-response-field": "interview_type" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" } }, "required": [ "name" ] } } }, "DiscoveryInterviewUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview starts.", "x-aha-response-field": "start_time" }, "end_time": { "type": "string", "format": "date-time", "description": "Date and time when the interview ends.", "x-aha-response-field": "end_time" }, "status": { "type": "string", "enum": [ "scheduling", "scheduled", "processing", "analyzing", "completed", "canceled" ], "description": "Status of the interview.", "x-aha-response-field": "status" }, "mode": { "type": "string", "enum": [ "in_person", "phone", "video", "focus_group", "observation", "document_analysis" ], "description": "Mode of the interview.", "x-aha-response-field": "mode" }, "study_id": { "type": "string", "description": "ID of the study containing the interview.", "x-aha-response-field": "study" }, "interview_type_id": { "type": "string", "description": "ID of the type of interview.", "x-aha-response-field": "interview_type" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } }, "DiscoveryStudyCreateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "status": { "type": "string", "enum": [ "planned", "in_progress", "postponed", "completed", "canceled" ], "description": "Status of the study.", "x-aha-response-field": "status" }, "study_type_id": { "type": "string", "description": "ID of the type associated with the study.", "x-aha-response-field": "study_type" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } }, "required": [ "name", "project_id" ] } } }, "DiscoveryStudyUpdateInput": { "type": "object", "required": [ "record" ], "properties": { "record": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the record.", "x-aha-response-field": "name" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the record.", "x-aha-response-field": "start_date" }, "end_date": { "type": "string", "format": "date", "description": "End date of the record.", "x-aha-response-field": "end_date" }, "status": { "type": "string", "enum": [ "planned", "in_progress", "postponed", "completed", "canceled" ], "description": "Status of the study.", "x-aha-response-field": "status" }, "study_type_id": { "type": "string", "description": "ID of the type associated with the study.", "x-aha-response-field": "study_type" }, "description": { "type": "string", "description": "HTML description of the record.", "x-aha-response-field": "description" }, "project_id": { "type": "string", "description": "ID of the workspace that contains the record.", "x-aha-response-field": "project" }, "custom_fields": { "$ref": "#/components/schemas/CustomFieldsInput", "x-aha-response-field": "custom_fields" } } } } } }, "parameters": { "PerPage": { "name": "per_page", "in": "query", "required": false, "description": "Number of records per page (default 25, max 200)", "schema": { "type": "integer", "default": 25, "minimum": 1, "maximum": 200 } }, "After": { "name": "after", "in": "query", "required": false, "description": "Opaque cursor from a previous response to fetch the next page", "schema": { "type": "string" } }, "Fields": { "name": "fields", "in": "query", "required": false, "description": "Comma-separated list of fields to include. Use 'default' to include all default fields plus extras. Use dot-notation or brackets for nested fields (e.g., requirements[id,name]). Custom fields: custom_fields.key_name. Collections can only be selected on the top-level resource.", "schema": { "type": "string" } } }, "responses": { "BadRequest": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Insufficient permissions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Record not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Conflict": { "description": "Record already exists or conflicts with the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ValidationFailed": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "DeletionFailed": { "description": "The record cannot be deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } } } } }