AgileZen API Documentation

Enrichments

Just like the application itself, the AgileZen API is designed to be as flexible as possible. By default, a GET request will return only a short summary of information about a resource. You can customize the information that is sent back by using enrichments.

For example, if you make a request to:

https://agilezen.com/api/v1/projects/1

AgileZen will respond with a summary of the project resource:

{
  "id": 1,
  "name": "Sudden Valley",
  "description": "I can see myself marinating a chicken in that.",
  "createTime": "2011-02-17T18:47:16",
  "owner": {
    "id": 1,
    "name": "Gob Bluth",
    "userName": "gob",
    "email": "Gob@bluth.com"
  }
}

In order to get additional information about this project, you can ask for one or more enrichments by using the the with argument. For example, to add a list of members to the response:

https://agilezen.com/api/v1/projects/1?with=members

AgileZen will then add member information to the response, like this:

{
  "id": 1,
  "name": "Sudden Valley",
  "description": "I can see myself marinating a chicken in that.",
  "createTime": "2011-02-17T18:47:16",
  "owner": {
    "id": 1,
    "name": "Gob Bluth",
    "userName": "gob",
    "email": "Gob@bluth.com"
  },
  "members": [
    {
      "id": 1,
      "name": "Gob Bluth"
    },
    {
      "id": 2,
      "name": "Michael Bluth"
    },
    {
      "id": 3,
      "name": "Lucille Bluth"
    },
    {
      "id": 4,
      "name": "Lindsay Funke"
    },
    {
      "id": 5,
      "name": "Tobias Funke"
    },
    {
      "id": 6,
      "name": "George Michael Bluth"
    },
    {
      "id": 7,
      "name": "Maeby Funke"
    },
    {
      "id": 8,
      "name": "Buster Bluth"
    }
  ]
}

You can also specify multiple enrichments by separating them with commas. In this way, you can request as many enrichments as you’d like:

https://agilezen.com/api/v1/projects/1?with=members,metrics

Enrichments work on both entity and container resources. When they’re used on container resources, the enrichments are applied to all entities within the container. The enrichments available for each resource are documented on the individual resource pages.