Cloud REST API

Browse the available end points for the Ativo cloud API.

The REST endpoints below allow you to retrieve Ativo configuration data via an API token.

This page is for the Cloud API.

The Ativo Programs API is in BETA, meaning breaking changes can occur without notification. Please keep an eye on this page for updates. Contact support in case of questions.

Team

Get the list of teams

get
Responses
200
OK
*/*
get
GET /rest/api/1/team HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

[
  {
    "id": 1,
    "key": "text",
    "name": "text"
  }
]

Get a team configuration

get
Path parameters
idinteger · int64Required
Responses
200
OK
*/*
get
GET /rest/api/1/team/{id} HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

{
  "id": 1,
  "key": "text",
  "name": "text",
  "mode": "SCRUM",
  "estimation": "STORY_POINTS",
  "configFilter": {
    "jiraFilterBody": {
      "id": "text"
    },
    "manualFilterBody": {
      "projects": {
        "selectionOn": "PROJECT",
        "values": [
          {
            "id": "text"
          }
        ]
      },
      "fieldFilters": [
        {
          "field": {
            "id": "text"
          },
          "values": [
            {
              "id": "text"
            }
          ],
          "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
          "operator": "IN"
        }
      ]
    },
    "filterMode": "JIRA"
  },
  "board": {
    "id": 1
  },
  "type": "BOARD",
  "isArchived": true
}

Get all team configurations

get
Responses
200
OK
*/*
get
GET /rest/api/1/teams HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

[
  {
    "id": 1,
    "key": "text",
    "name": "text",
    "mode": "SCRUM",
    "estimation": "STORY_POINTS",
    "configFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "values": [
              {
                "id": "text"
              }
            ],
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN"
          }
        ]
      },
      "filterMode": "JIRA"
    },
    "board": {
      "id": 1
    },
    "type": "BOARD",
    "isArchived": true
  }
]

Program (ART)

Get the list of programs (ARTs)

get
Responses
200
OK
*/*
get
GET /rest/api/1/program HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

[
  {
    "id": 1,
    "key": "text",
    "name": "text"
  }
]

Get a program (ART) configuration

get
Path parameters
idinteger · int64Required
Responses
200
OK
*/*
get
GET /rest/api/1/program/{id} HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

{
  "id": 1,
  "key": "text",
  "name": "text",
  "combinedFilter": {
    "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
    "epicMode": "PROGRAM_EPICS_IN_FILTER",
    "epicFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "values": [
              {
                "id": "text"
              }
            ],
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN"
          }
        ]
      },
      "filterMode": "JIRA"
    },
    "issueFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "values": [
              {
                "id": "text"
              }
            ],
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN"
          }
        ]
      },
      "filterMode": "JIRA"
    }
  },
  "teams": [
    {
      "id": 1,
      "key": "text",
      "name": "text"
    }
  ],
  "isArchived": true
}

Get all program (ART) configurations

get
Responses
200
OK
*/*
get
GET /rest/api/1/programs HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

[
  {
    "id": 1,
    "key": "text",
    "name": "text",
    "combinedFilter": {
      "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
      "epicMode": "PROGRAM_EPICS_IN_FILTER",
      "epicFilter": {
        "jiraFilterBody": {
          "id": "text"
        },
        "manualFilterBody": {
          "projects": {
            "selectionOn": "PROJECT",
            "values": [
              {
                "id": "text"
              }
            ]
          },
          "fieldFilters": [
            {
              "field": {
                "id": "text"
              },
              "values": [
                {
                  "id": "text"
                }
              ],
              "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
              "operator": "IN"
            }
          ]
        },
        "filterMode": "JIRA"
      },
      "issueFilter": {
        "jiraFilterBody": {
          "id": "text"
        },
        "manualFilterBody": {
          "projects": {
            "selectionOn": "PROJECT",
            "values": [
              {
                "id": "text"
              }
            ]
          },
          "fieldFilters": [
            {
              "field": {
                "id": "text"
              },
              "values": [
                {
                  "id": "text"
                }
              ],
              "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
              "operator": "IN"
            }
          ]
        },
        "filterMode": "JIRA"
      }
    },
    "teams": [
      {
        "id": 1,
        "key": "text",
        "name": "text"
      }
    ],
    "isArchived": true
  }
]

Period (PI)

Get the list of periods (PIs)

get
Responses
200
OK
*/*
get
GET /rest/api/1/period HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

[
  {
    "id": 1,
    "key": "text",
    "name": "text"
  }
]

Get a period (PI) configuration

get
Path parameters
idinteger · int64Required
Responses
200
OK
*/*
get
GET /rest/api/1/period/{id} HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

{
  "id": 1,
  "key": "text",
  "name": "text",
  "sprints": [
    {
      "id": 1,
      "key": "text",
      "name": "text",
      "closed": true,
      "startDate": "text",
      "endDate": "text",
      "teamSprints": [
        {
          "sprintJiraId": 1,
          "teamKey": "text"
        }
      ]
    }
  ],
  "programIncrements": [
    {
      "programId": 1,
      "combinedFilter": {
        "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
        "epicMode": "PROGRAM_EPICS_IN_FILTER",
        "epicFilter": {
          "jiraFilterBody": {
            "id": "text"
          },
          "manualFilterBody": {
            "projects": {
              "selectionOn": "PROJECT",
              "values": [
                {
                  "id": "text"
                }
              ]
            },
            "fieldFilters": [
              {
                "field": {
                  "id": "text"
                },
                "values": [
                  {
                    "id": "text"
                  }
                ],
                "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                "operator": "IN"
              }
            ]
          },
          "filterMode": "JIRA"
        },
        "issueFilter": {
          "jiraFilterBody": {
            "id": "text"
          },
          "manualFilterBody": {
            "projects": {
              "selectionOn": "PROJECT",
              "values": [
                {
                  "id": "text"
                }
              ]
            },
            "fieldFilters": [
              {
                "field": {
                  "id": "text"
                },
                "values": [
                  {
                    "id": "text"
                  }
                ],
                "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                "operator": "IN"
              }
            ]
          },
          "filterMode": "JIRA"
        }
      },
      "teams": [
        {
          "id": 1,
          "key": "text",
          "name": "text"
        }
      ]
    }
  ],
  "isArchived": true
}

Get all period (PI) configurations

get
Responses
200
OK
*/*
get
GET /rest/api/1/periods HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

[
  {
    "id": 1,
    "key": "text",
    "name": "text",
    "sprints": [
      {
        "id": 1,
        "key": "text",
        "name": "text",
        "closed": true,
        "startDate": "text",
        "endDate": "text",
        "teamSprints": [
          {
            "sprintJiraId": 1,
            "teamKey": "text"
          }
        ]
      }
    ],
    "programIncrements": [
      {
        "programId": 1,
        "combinedFilter": {
          "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
          "epicMode": "PROGRAM_EPICS_IN_FILTER",
          "epicFilter": {
            "jiraFilterBody": {
              "id": "text"
            },
            "manualFilterBody": {
              "projects": {
                "selectionOn": "PROJECT",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              },
              "fieldFilters": [
                {
                  "field": {
                    "id": "text"
                  },
                  "values": [
                    {
                      "id": "text"
                    }
                  ],
                  "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                  "operator": "IN"
                }
              ]
            },
            "filterMode": "JIRA"
          },
          "issueFilter": {
            "jiraFilterBody": {
              "id": "text"
            },
            "manualFilterBody": {
              "projects": {
                "selectionOn": "PROJECT",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              },
              "fieldFilters": [
                {
                  "field": {
                    "id": "text"
                  },
                  "values": [
                    {
                      "id": "text"
                    }
                  ],
                  "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                  "operator": "IN"
                }
              ]
            },
            "filterMode": "JIRA"
          }
        },
        "teams": [
          {
            "id": 1,
            "key": "text",
            "name": "text"
          }
        ]
      }
    ],
    "isArchived": true
  }
]

Objectives

Get the program and team objectives for a PI

get
Path parameters
programIdinteger · int64Required
periodIdinteger · int64Required
Responses
200
OK
*/*
get
GET /rest/api/1/objectives/{programId}/{periodId} HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*
200

OK

{
  "id": 1,
  "key": "text",
  "name": "text",
  "programId": 1,
  "periodId": 1,
  "objectives": [
    {
      "level": "PROGRAM",
      "teamId": 1,
      "commitment": "COMMITTED",
      "label": "text",
      "plannedValue": 1,
      "deliveredValue": 1,
      "epicIds": [
        "text"
      ]
    }
  ],
  "showEpicLinks": true
}

Last updated