Goals
Create a goal
post/products/{product_id}/goals
Request
- Base URLhttps://company.aha.io/api/v1
- Auth
- OAuth 2Authorization codehttps://{account-domain}.aha.io/oauth/authorizeToken URLhttps://{account-domain}.aha.io/oauth/token
- or HTTP bearer
- or API key in cookie session
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
product_idstring required
ProductId identifier
Request body
Example request
{
"goal": {
"description": "An even smarter goal.",
"workflow_status": "On Track"
}
}Response
Successful operation
Example response
{
"goal": {
"id": "6776881149493942444",
"name": "Goal 3",
"reference_num": "PRJ1-G-1",
"effort": 95,
"value": 26,
"color": "#397e82",
"position": 6,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"progress": 0,
"progress_source": "progress_manual",
"url": "https://company.aha.io/strategic_imperatives/PRJ1-G-1",
"resource": "https://company.aha.io/strategic_imperatives/PRJ1-G-1",
"description": {
"id": "6776881149487765710",
"body": "",
"notable_id": "6776881149493942444",
"notable_type": "StrategicImperative",
"editor_version": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"success_metric": {
"name": "FooBar",
"description": {
"id": "6776881149497706592",
"body": "Foo Bar",
"notable_id": "6776881149490264804",
"notable_type": "StrategicImperativeMetric",
"editor_version": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"workflow_status": {
"id": "412273758",
"name": "Not Started",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"workflow_status_times": [
{
"status_id": "412273758",
"status_name": "Not Started",
"started_at": "2019-01-01T00:00:00.000Z",
"ended_at": null
}
]
},
"project": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"initiatives": [],
"key_results": [],
"comments_count": 0,
"features": [],
"releases": [],
"custom_fields": [],
"watchers": [
{
"id": "16338845",
"name": "John Smith",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "689956296",
"name": "Henry Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "1020675218",
"name": "Mary Humpty",
"email": "no-reply@aha.io",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z"
}
]
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.