Goals
put/products/{product_id}/goals/{id}

Request

Path parameters

product_idstring required

ProductId identifier

idstring required

Id identifier

Request body

Example request

{
  "goal": {
    "description": "An even smarter goal.",
    "workflow_status": "On Track"
  }
}

Response

Successful operation

Example response

{
  "goal": {
    "id": "602095703",
    "name": "Goal 1",
    "reference_num": "DEMOENT-G-1",
    "effort": 10,
    "value": 70,
    "color": "#bada55",
    "position": 1,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "product_id": "131414752",
    "progress": null,
    "progress_source": "progress_manual",
    "url": "https://company.aha.io/strategic_imperatives/DEMOENT-G-1",
    "resource": "https://company.aha.io/strategic_imperatives/DEMOENT-G-1",
    "description": {
      "id": "166463080",
      "body": "Description of goal 1",
      "notable_id": "602095703",
      "notable_type": "StrategicImperative",
      "editor_version": 1,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "success_metric": {
      "name": "Metric 1",
      "description": {
        "id": "546284368",
        "body": "Description of goal 1",
        "notable_id": "1060592970",
        "notable_type": "StrategicImperativeMetric",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "workflow_status": {
        "id": "396368932",
        "name": "On Track",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f",
        "workflow_status_category": {
          "id": "112353881",
          "name": "In progress"
        }
      }
    },
    "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": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "reference_num": "PRJ1-S-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "https://company.aha.io/initiatives/PRJ1-S-1",
        "resource": "https://company.aha.io/api/v1/initiatives/PRJ1-S-1",
        "description": {
          "id": "673273729",
          "body": "Description of initiative 1",
          "notable_id": "423077122",
          "notable_type": "Initiative",
          "editor_version": 1,
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "attachments": []
        },
        "integration_fields": [
          {
            "id": "546711007",
            "name": "id",
            "value": "9913333",
            "integration_id": 186281709,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "966751335",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 186281709,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ]
      }
    ],
    "key_results": [
      {
        "id": "631791848",
        "name": "KR 1",
        "reference_num": "DEMOENT-G-1-KR-1",
        "url": "https://company.aha.io/key_results/DEMOENT-G-1-KR-1",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "progress": null,
        "target_metric": "100%",
        "starting_metric": "5%",
        "current_metric": "20%"
      },
      {
        "id": "1017196896",
        "name": "KR 2",
        "reference_num": "DEMOENT-G-1-KR-2",
        "url": "https://company.aha.io/key_results/DEMOENT-G-1-KR-2",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "progress": null,
        "target_metric": null,
        "starting_metric": null,
        "current_metric": null
      }
    ],
    "comments_count": 1,
    "features": [
      {
        "id": "1007868956",
        "name": "Feature 1",
        "reference_num": "PRJ1-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "product_id": "131414752",
        "url": "https://company.aha.io/features/PRJ1-1",
        "resource": "https://company.aha.io/api/v1/features/PRJ1-1"
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "product_id": "131414752",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2019-01-01",
        "release_date": "2019-01-01",
        "parking_lot": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "https://company.aha.io/releases/PRJ1-R-1",
        "resource": "https://company.aha.io/api/v1/releases/PRJ1-R-1",
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "owner": {
          "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"
        },
        "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"
        }
      }
    ],
    "custom_fields": []
  }
}

Changes

    • breaking

      the /// response's property type changed from object to string for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added the optional property /// to the response with the status