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 9 months ago

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

Program (ART)

Period (PI)

Objectives

Get a team configuration

get

/rest/api/1/team/{id}

Path parameters
idinteger · int64required
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/team/{id}'
200
{
  "id": 1,
  "key": "text",
  "name": "text",
  "configFilter": {
    "jiraFilterBody": {
      "id": "text"
    },
    "manualFilterBody": {
      "projects": {
        "selectionOn": "PROJECT",
        "values": [
          {
            "id": "text"
          }
        ]
      },
      "fieldFilters": [
        {
          "field": {
            "id": "text"
          },
          "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
          "operator": "IN",
          "values": [
            {
              "id": "text"
            }
          ]
        }
      ]
    },
    "filterMode": "JIRA"
  },
  "board": {
    "id": 1
  },
  "isArchived": true,
  "mode": "SCRUM",
  "estimation": "STORY_POINTS",
  "type": "BOARD"
}

OK

Get all team configurations

get

/rest/api/1/teams

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/teams'
200
[
  {
    "id": 1,
    "key": "text",
    "name": "text",
    "configFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN",
            "values": [
              {
                "id": "text"
              }
            ]
          }
        ]
      },
      "filterMode": "JIRA"
    },
    "board": {
      "id": 1
    },
    "isArchived": true,
    "mode": "SCRUM",
    "estimation": "STORY_POINTS",
    "type": "BOARD"
  }
]

OK

Get a program (ART) configuration

get

/rest/api/1/program/{id}

Path parameters
idinteger · int64required
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/program/{id}'
200
{
  "id": 1,
  "key": "text",
  "name": "text",
  "combinedFilter": {
    "epicFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN",
            "values": [
              {
                "id": "text"
              }
            ]
          }
        ]
      },
      "filterMode": "JIRA"
    },
    "issueFilter": {
      "jiraFilterBody": {
        "id": "text"
      },
      "manualFilterBody": {
        "projects": {
          "selectionOn": "PROJECT",
          "values": [
            {
              "id": "text"
            }
          ]
        },
        "fieldFilters": [
          {
            "field": {
              "id": "text"
            },
            "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
            "operator": "IN",
            "values": [
              {
                "id": "text"
              }
            ]
          }
        ]
      },
      "filterMode": "JIRA"
    },
    "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
    "epicMode": "PROGRAM_EPICS_IN_FILTER"
  },
  "isArchived": true,
  "teams": [
    {
      "id": 1,
      "key": "text",
      "name": "text"
    }
  ]
}

OK

Get all program (ART) configurations

get

/rest/api/1/programs

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/programs'
200
[
  {
    "id": 1,
    "key": "text",
    "name": "text",
    "combinedFilter": {
      "epicFilter": {
        "jiraFilterBody": {
          "id": "text"
        },
        "manualFilterBody": {
          "projects": {
            "selectionOn": "PROJECT",
            "values": [
              {
                "id": "text"
              }
            ]
          },
          "fieldFilters": [
            {
              "field": {
                "id": "text"
              },
              "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
              "operator": "IN",
              "values": [
                {
                  "id": "text"
                }
              ]
            }
          ]
        },
        "filterMode": "JIRA"
      },
      "issueFilter": {
        "jiraFilterBody": {
          "id": "text"
        },
        "manualFilterBody": {
          "projects": {
            "selectionOn": "PROJECT",
            "values": [
              {
                "id": "text"
              }
            ]
          },
          "fieldFilters": [
            {
              "field": {
                "id": "text"
              },
              "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
              "operator": "IN",
              "values": [
                {
                  "id": "text"
                }
              ]
            }
          ]
        },
        "filterMode": "JIRA"
      },
      "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
      "epicMode": "PROGRAM_EPICS_IN_FILTER"
    },
    "isArchived": true,
    "teams": [
      {
        "id": 1,
        "key": "text",
        "name": "text"
      }
    ]
  }
]

OK

Get a period (PI) configuration

get

/rest/api/1/period/{id}

Path parameters
idinteger · int64required
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/period/{id}'
200
{
  "id": 1,
  "key": "text",
  "name": "text",
  "isArchived": true,
  "sprints": [
    {
      "id": 1,
      "key": "text",
      "name": "text",
      "closed": true,
      "startDate": "text",
      "endDate": "text",
      "teamSprints": [
        {
          "sprintJiraId": 1,
          "teamKey": "text"
        }
      ]
    }
  ],
  "programIncrements": [
    {
      "programId": 1,
      "combinedFilter": {
        "epicFilter": {
          "jiraFilterBody": {
            "id": "text"
          },
          "manualFilterBody": {
            "projects": {
              "selectionOn": "PROJECT",
              "values": [
                {
                  "id": "text"
                }
              ]
            },
            "fieldFilters": [
              {
                "field": {
                  "id": "text"
                },
                "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                "operator": "IN",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              }
            ]
          },
          "filterMode": "JIRA"
        },
        "issueFilter": {
          "jiraFilterBody": {
            "id": "text"
          },
          "manualFilterBody": {
            "projects": {
              "selectionOn": "PROJECT",
              "values": [
                {
                  "id": "text"
                }
              ]
            },
            "fieldFilters": [
              {
                "field": {
                  "id": "text"
                },
                "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                "operator": "IN",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              }
            ]
          },
          "filterMode": "JIRA"
        },
        "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
        "epicMode": "PROGRAM_EPICS_IN_FILTER"
      },
      "teams": [
        {
          "id": 1,
          "key": "text",
          "name": "text"
        }
      ]
    }
  ]
}

OK

Get all period (PI) configurations

get

/rest/api/1/periods

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/periods'
200
[
  {
    "id": 1,
    "key": "text",
    "name": "text",
    "isArchived": true,
    "sprints": [
      {
        "id": 1,
        "key": "text",
        "name": "text",
        "closed": true,
        "startDate": "text",
        "endDate": "text",
        "teamSprints": [
          {
            "sprintJiraId": 1,
            "teamKey": "text"
          }
        ]
      }
    ],
    "programIncrements": [
      {
        "programId": 1,
        "combinedFilter": {
          "epicFilter": {
            "jiraFilterBody": {
              "id": "text"
            },
            "manualFilterBody": {
              "projects": {
                "selectionOn": "PROJECT",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              },
              "fieldFilters": [
                {
                  "field": {
                    "id": "text"
                  },
                  "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                  "operator": "IN",
                  "values": [
                    {
                      "id": "text"
                    }
                  ]
                }
              ]
            },
            "filterMode": "JIRA"
          },
          "issueFilter": {
            "jiraFilterBody": {
              "id": "text"
            },
            "manualFilterBody": {
              "projects": {
                "selectionOn": "PROJECT",
                "values": [
                  {
                    "id": "text"
                  }
                ]
              },
              "fieldFilters": [
                {
                  "field": {
                    "id": "text"
                  },
                  "jqlGeneratePattern": "WHERE_FIELD_IN_VALUE_LABEL",
                  "operator": "IN",
                  "values": [
                    {
                      "id": "text"
                    }
                  ]
                }
              ]
            },
            "filterMode": "JIRA"
          },
          "mode": "PROGRAM_FILTER_EPIC_AND_ISSUES_UNDER_EPIC",
          "epicMode": "PROGRAM_EPICS_IN_FILTER"
        },
        "teams": [
          {
            "id": 1,
            "key": "text",
            "name": "text"
          }
        ]
      }
    ]
  }
]

OK

Get the list of periods (PIs)

get

/rest/api/1/period

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/period'
200
[
  {
    "id": 1,
    "key": "text",
    "name": "text"
  }
]

OK

Get the program and team objectives for a PI

get

/rest/api/1/objectives/{programId}//{periodId}

Path parameters
programIdinteger · int64required
periodIdinteger · int64required
Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/objectives/{programId}/{periodId}'
200
{
  "id": 1,
  "key": "text",
  "name": "text",
  "programId": 1,
  "periodId": 1,
  "showEpicLinks": true,
  "objectives": [
    {
      "teamId": 1,
      "label": "text",
      "plannedValue": 1,
      "deliveredValue": 1,
      "level": "PROGRAM",
      "commitment": "COMMITTED",
      "epicIds": [
        "text"
      ]
    }
  ]
}

OK

Get the list of teams

get

/rest/api/1/team

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/team'
200
[
  {
    "id": 1,
    "key": "text",
    "name": "text"
  }
]

OK

Get the list of programs (ARTs)

get

/rest/api/1/program

Responses
*/*
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://cloud-api.ativo.io/rest/api/1/program'
200
[
  {
    "id": 1,
    "key": "text",
    "name": "text"
  }
]

OK

  • 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