The Team Server API is deprecated. Please use the App Repository API instead.
1 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 (see the Deploy API for more information about retrieving applications and application identifiers).
The image below provides a domain model representation of the concepts discussed below and how these are related:
The team server API is only available to licensed apps which are running in a Mendix Cloud.
2 Authentication
The Developer Portal Management API requires its users to authenticate themselves. This can be done by using API keys; for more information about this please see Authentication.
3 API Calls
3.1 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.
1
2
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/branches
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.
1
2
HTTP Method: GET
URL: https://deploy.mendix.com/api/1/apps/<AppId>/branches/<Name>/revisions
3.3.1 Request
3.3.1.1 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.
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.
3.3.2.1 Error Codes
HTTP Status
Error code
Description
400
INVALID_APPID
Invalid AppId.
404
APP_NOT_FOUND
App not found.
404
BRANCH_NOT_FOUND
There is no branch with name ‘branch name’.
3.3.2.2 Example
1
2
3
4
5
6
7
8
9
10
11
12
13
[{"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"}]