REST API

This document describes the AgilePoint REST API. AgilePoint recommends this API especially for use with mobile applications. JavaScript, Java, and C# examples are provided for each method.

This API has the following endpoints. The name of your AgilePoint Server directory depends upon whether you are using AgilePoint on premises or AgilePoint for Azure:

• Workflow API - https://[qualified machine name]:[port]/[AgilePointServer or AgilePointService]/Workflow
• Administration API - https://[qualified machine name]:[port]/[AgilePointServer or AgilePointService]/Admin

Good to Know

• For jQuery version 1.9 and higher, for a REST service that returns a response of null or {}, The REST API call dataType must be Text.

Video: Show Data from a REST Service on an eForm

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

• AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
• Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
• Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.