ATathenian
align
default

Retrieve a goal template.

Changed on
get/goal_template/{id}

Request

Response

The retrieved goal template.

availableboolean required

Whether the templates is avaiable for use.

idinteger required

Identifier of the template.

namestring required

Name of the template.

repositoriesRepositoryID[]

Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.

Example response

{
  "available": true,
  "id": 42,
  "metric": "pr-release-time",
  "name": "Untitled Template",
  "repositories": [
    "github.com/athenianco/athenian-api",
    "github.com/athenianco/api-spec"
  ]
}

Changes

  • 63ec2eb2e4b3Revision changes
    • warning

      added the new jira-acknowledge-time-below-threshold-ratio enum value to the //// response property for the response status

  • da81d83d9501Revision changes
    • warning

      added the new jira-life-time-below-threshold-ratio enum value to the //// response property for the response status

    • warning

      added the new pr-cycle-time-below-threshold-ratio enum value to the //// response property for the response status

    • warning

      added the new pr-live-cycle-count enum value to the //// response property for the response status

    • warning

      added the new pr-live-cycle-count-q enum value to the //// response property for the response status

    • warning

      added the new pr-live-cycle-time enum value to the //// response property for the response status

    • warning

      added the new pr-merging-time-below-threshold-ratio enum value to the //// response property for the response status

    • warning

      added the new pr-wip-time-below-threshold-ratio enum value to the //// response property for the response status

    • info

      added the required property to the response with the status