API integration

To integrate an application with Agile Manager, Site Administrators must add it on the Agile Manager Integrations > API configuration tab. For details, see Obtain client details for API access.

In this topic:

Introduction

Applications in the context of API refer to the application you are developing, and want to integrate with Agile Manager.

These are notAgile Manager applications, used within Agile Manager to organize a backlog.

For details about Agile Manager applications, see Work with applications.

Notes:

• Applications can be written in any language and on any platform that support REST. Request and return data are in JSON format unless specified otherwise.
• The API communicates via HTTPS.

• Your application server stores a client token used to authenticate on the Agile Manager API. This token, and the client ID and secret used to acquire it, should be stored with the same security considerations used to store passwords.

See API authentication for an overview of authentication and the flow of requests.

Back to top

General resources

Developers can retrieve and operate on the entities that are available in the Agile Manager graphical user interface. This includes releases, backlog items, workspaces, and more.

The release_teams and team_members resources represent pairing of releases to teams or teams to members. These resources do not contain data related to the releases, teams, or members.

This supports:

• Releases containing multiple teams

• Teams assigned to multiple releases

• Teams with multiple members

• Users belonging to multiple teams

Retrieving an entity's history

For themes, features, backlog items, and tasks, developers can retrieve an entity's history, to review changes that were made to the entity.

To retrieve history for a specific entity, add an audits parameter to the call you would use to retrieve the entity.

For example, to retrieve history for a user story: 

Back to top

Unique resources

The following tables lists unique API resources:

Resource	Description
timesheet	Developers can retrieve time sheet data stored in Agile Manager for specific users and date ranges. This is useful for project and portfolio management software, such as Micro Focus Project and Portfolio Management (PPM). Only data entered to Agile Manager after April 2015 is available via API. Data entered beforehand is not reflected in timesheet reports.
action_items.	Developers can retrieve a list of the action items that were decided in a sprint closure meeting.
custom_fields.	Developers can retrieve a list of the names and API names of custom fields defined in their system. This helps match custom field names to their API names. You can retrieve the names of the custom fields defined at the site level and/or in specific workspaces.
kanban_statuses.	Developers can retrieve a list of Kanban Statuses for each team in the workspace. For each status, the status ID, name, and the mapped backlog item status are returned. For example, you can use this resource to get the Kanban status name for the Kanban status ID that was returned for a backlog item.
link_errors link_error_details	Developers can retrieve Synchronizer errors and their details.

Back to top

API Interactive Help

Use our interactive API help to explore supported entities, and to request data from Agile Manager. You can interact with Agile Manager directly from the Interactive Help, or by copying examples into your code.

Access the Interactive Help from the Agile Manager Help menu (Help > API Interactive Help), or from the Integrations > API configuration page.

1. To perform interactive operations, at the top of the page, enter your client ID and secret, and then click Authenticate.

   Note: You can view available resources, operations, and parameters even without entering credentials. You must enter credentials only to submit operations.

2. Expand unique and general resources and operations for more details about each one.

   The timesheet resource is a unique resource, with operations specified for generating timesheet data.

   Workspaces, releases, backlog_items, and more are general resources, all with the same operations.

3. For each operation, enter parameter values in Value column fields, as described in the Description column.

4. Click Submit to perform the operation using the parameters you've specified, or copy examples or syntax into your code.

   Click to view a sample response:

   

For more details about integrating with PPM, see the Project and Portfolio Management Help Center.

Back to top

See also:

• API exceptions
• Code samples
• API development and usage flow