missionX API

2.0.0-beta.1

The same API missionX uses for its own UI, customized for licensed organizations.

What to expect from V2

• All endpoints that list multiple results are now paginated.
• Paginated endpoints offer more query parameters for more granular filtering.
• Reduced latency, especially for paginated endpoints
• Requests per second limit increased from 4req/s to 10req/s

How pagination works

• Results are still provided within the value property of the response
• Results are now by default limited to 40 results (extendable up to 100)
• If more results exists, then a nextLink property will be in the response. Use it as is to fetch the next paginated results
• If results have been exhausted, nextLink will not be defined

Migrating from V1 to V2

Generally, endpoints that do not list multiple results have not been affected. So all POST, PATCH, DELETE methods and almost all of the GET methods that return a single value (e.g. GET /timesheets/{timesheetId}) are backwards compatible with V1.

Breaking Changes

• All endpoints that are now paginated: GET /projects, GET /projects/{projectId}/planItems, GET /timesheets.
• The URL for all client endpoints has changed. Specifically, the org/ prefix has been removed, e.g. POST /orgs/clients is now POST /clients.
• GET /orgs/me does not include anymore the people and clients properties. Use the new dedicated endpoints to fetch both.
• The field archivedAt was removed for archived org people.
• GET /projects does not return by default the people property anymore. Use expand=people to include.

New endpoints added:

• GET /orgs/people: List org people
• GET /clients: List org clients
• GET /planItems: List org planItems (across projects).