Team Server API

Introduction

The Team Server API allows you to retrieve the information (branches, revisions) of application models stored in our Team Server. You always access an application model via the context of an application (for more information about retrieving applications and application identifiers, see the Deploy API v1).

The image below provides a domain model representation of the concepts discussed below and how these are related:

Authentication

The Team Server API requires authentication via API keys that are bound to your Mendix account.

Obtaining an API Key

To obtain a Mendix API key, follow the instructions in the API Keys section of Mendix Profile.

Using Authentication Headers

Use the following request headers to authenticate an API call:

• Mendix-Username – the login name of the requesting user with the required privileges in the Mendix Platform
• Mendix-ApiKey – the API key of this user

Configuring Permissions

To perform an action via the Team Server API, you need API Rights permissions. This can be configured from the Permissions tab of your app’s Environments page.

API Calls

Retrieve Branches

Retrieves all branches that belong to the team server project of a specific app which the authenticated user has access to as a regular user.

HTTP Method: GET
 URL: https://deploy.mendix.com/api/1/apps/<AppId>/branches

Request

Parameter

• AppId (String) : Subdomain name of an app.

Example

GET /api/1/apps/calc/branches HTTP/1.1
Host: deploy.mendix.com

Accept: */*
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6

Output

List of objects with the following key-value pairs:

• Name (String) : Name of the branch. This is ’trunk’ for the main line or a specific branch name.
• DisplayName (String) : Visible name in the Mendix Portal. For the trunk, this is ‘Main line’.
• LatestRevisionNumber (Long) : Number of the latest revision.
• LatestRevisionMendixVersion (String) : Version string of the Mendix version of the app in this revision.

Error Codes

Example

[{
     "Name" :  "trunk" ,
     "LatestRevisionNumber" :  9 ,
     "LatestRevisionMendixVersion" :  "5.6.0" ,
     "DisplayName" :  "Main line"
},{
     "Name" :  "statistical functions" ,
     "LatestRevisionNumber" :  13 ,
     "LatestRevisionMendixVersion" :  "5.6.0" ,
     "DisplayName" :  "statistical functions"
}]

Retrieve Branch

Retrieves a specific branch that belongs to the team server project of a specific app which the authenticated user has access to as a regular user.

 HTTP Method: GET
 URL: https://deploy.mendix.com/api/1/apps/<AppId>/branches/<Name>

Request

Parameters

• AppId (String) : Subdomain name of an app.
• Name (String) : Name of the branch to get or ’trunk’ to get the main line. The name of the branch should be URL-encoded.

Example

GET /api/1/apps/calc/branches/statistical%20functions HTTP/1.1
Host: deploy.mendix.com

Accept: */*
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6

Output

An object with the following key-value pairs:

• Name (String) : Name of the branch. This is ’trunk’ for the main line or a specific branch name.
• DisplayName (String) : Visible name in the Mendix Portal. For the trunk, this is ‘Main line’.
• LatestRevisionNumber (Long) : Number of the latest revision.
• LatestRevisionMendixVersion (String) : Version string of the Mendix version of the app in the latest revision.

Error Codes

Example

{
    "Name": "statistical functions",
    "LatestRevisionNumber": 13,
    "LatestRevisionMendixVersion": "5.6.0",
    "DisplayName": "statistical functions"
}

Retrieve Revisions

Retrieves the last 20 revisions of a specific branch that belongs to the Team Server project of a specific app which the authenticated user has access to as a regular user.

HTTP Method: GET
 URL: https://deploy.mendix.com/api/1/apps/<AppId>/branches/<Name>/revisions

Request

Parameters

• AppId (String) : Subdomain name of an app.
• Name (String) : Name of the branch to get. Use trunk to get the main line or branches%2FyourBranchName for any other development branch.

Examples

GET /api/1/apps/calc/branches/trunk/revisions HTTP/1.1
Host: deploy.mendix.com

Accept: */*
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6

GET /api/1/apps/calc/branches/branches%2Fdevelopment/revisions HTTP/1.1
Host: deploy.mendix.com

Accept: */*
Mendix-Username: richard.ford51@example.com
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6

Output

List of objects with the following key-value pairs:

• Number (Long) : Number of the revision.
• CommitMessage (String) : Commit message of the revision.
• Date (Date) : Date when the revision is created (or the commit is done).
• Author (String) : Creator of the revision (committer).
• MendixVersion (String) : Version string of the Mendix version of the app in this revision.

Error Codes

Example

[{
    "MendixVersion": "5.6.0",
    "CommitMessage": "Implement C key",
    "Date": 1394031450618,
    "Number": 8,
    "Author": "richard.ford51@example.com"
},{
    "MendixVersion": "5.6.0",
    "CommitMessage": "Implement ^ key",
    "Date": 1394031460618,
    "Number": 9,
    "Author": "richard.ford51@example.com"
}]