Ativo Programs for Jira 📖 Documentation
  • Getting started
    • Quickstart guide
    • Prerequisites
    • Installation
      • Updates
    • Cheat sheet
  • Configuration
    • Permissions
    • Team
    • Program (release train)
    • Period (program increment)
    • Project and Jira (JQL) filters
  • Preparing a Program Increment (PI)
    • Program cycle
    • Feature backlog
  • Program Increment (PI) planning
    • Plan issues
    • Plan epics (features)
    • Plan dependencies
    • Raise risks and impediments
    • PI Objectives
    • Capacity
    • Team breakout
  • Scrum of scrums / Art Sync
    • Scrum of scrums and art-sync preparation
    • Progress per team
    • Progress per program
  • Cross-pi
    • Cross-PI dependencies
  • Advanced
    • Export issues, PI objectives, milestones and capacity to Excel
    • Ativo Programs custom fields
      • Field sharing
      • Ativo Program fields use PI keys since April 2023
    • Fields added to screens
    • Issue types
    • Limit permissions of suppliers
    • Jira Service Management tickets on the program board
    • Server to cloud migration
  • REST API
    • Authentication
    • Version
    • Cloud REST API Rate Limiting
    • Cloud REST API
    • Data Center REST API
  • Training
    • User training
Powered by GitBook
On this page
  1. REST API

Cloud REST API

Browse the available end points for the Ativo cloud API.

PreviousCloud REST API Rate LimitingNextData Center REST API

Last updated 1 year ago

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

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. in case of questions.

Team

Program (ART)

Period (PI)

Objectives

API token
Contact support

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 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 team configuration

get
Path parameters
idinteger · int64Required
Responses
200
OK
*/*
get
200

OK

Get all team configurations

get
Responses
200
OK
*/*
get
200

OK

Get a program (ART) configuration

get
Path parameters
idinteger · int64Required
Responses
200
OK
*/*
get
200

OK

Get all program (ART) configurations

get
Responses
200
OK
*/*
get
200

OK

Get a period (PI) configuration

get
Path parameters
idinteger · int64Required
Responses
200
OK
*/*
get
200

OK

Get all period (PI) configurations

get
Responses
200
OK
*/*
get
200

OK

GET /rest/api/1/team/{id} HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*

{
  "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 /rest/api/1/teams HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*

[
  {
    "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 /rest/api/1/program/{id} HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*

{
  "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 /rest/api/1/programs HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*

[
  {
    "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 /rest/api/1/period/{id} HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*

{
  "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 /rest/api/1/periods HTTP/1.1
Host: cloud-api.ativo.io
Accept: */*

[
  {
    "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 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 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
}
  • Team
  • GETGet the list of teams
  • GETGet a team configuration
  • GETGet all team configurations
  • Program (ART)
  • GETGet the list of programs (ARTs)
  • GETGet a program (ART) configuration
  • GETGet all program (ART) configurations
  • Period (PI)
  • GETGet the list of periods (PIs)
  • GETGet a period (PI) configuration
  • GETGet all period (PI) configurations
  • Objectives
  • GETGet the program and team objectives for a PI