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

Note: For your data security, AgilePoint strongly recommends using SSL (https) for all communication with the AgilePoint REST API.

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.

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.

PDFs

This table provides links to the AgilePoint NX documents that are available in PDF format.

Note: Some links point to the AgilePoint NX v7.x Documentation. Full v8.x PDF Documentation is coming soon.

PDF	Document Description
Startup Guide for AgilePoint NX OnDemand (PDF)	This section gives procedures to sign up and get started with AgilePoint NX OnDemand (public cloud).
v8.0 Release Notes	This document describes enhancements and fixes for the stated release.
v7.0 Release Notes	This document describes enhancements and fixes for the stated release.
v6.0 SP1 Release Notes	This document describes enhancements and fixes for the stated release.
v6.0 Release Notes	This document describes enhancements and fixes for the stated release.
System Requirements	This document describes hardware and software requirements for installing and running AgilePoint NX.
Governance Guide	This document describes the governance process for AgilePoint NX.
Security Guide for AgilePoint-Hosted Environments	This document provides information about security-related technologies, processes, policies, and procedures for AgilePoint NX environments that are hosted by AgilePoint.
PCI DSS Application Development in AgilePoint-Hosted Environments	This document provides information about creating and maintaining applications that are compliant with the PCI DSS standard in AgilePoint NX environments that are hosted by AgilePoint.
Architecture Guide	This document describes the hardware, software, and deployment architectures for AgilePoint NX.
Initial Hardware Estimation Guidelines	This document provides guidelines for hardware sizing and configuration for AgilePoint NX.
Performance Benchmark Analysis	This document helps businesses conduct a Benchmark Analysis on AgilePoint NX performance under load.
Installation Guide	This document provides instructions for installing AgilePoint NX.
Upgrade Guide	This document provides instructions to upgrade AgilePoint NX.
Web Services API Guide	This document describes the AgilePoint remote API, which you can access using a web service or a Windows service (WCF). The AgilePoint remote API is designed and implemented using the Microsoft .NET WCF framework.
REST API Guide	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.
Security Overview for AgilePoint NX OnDemand	This document describes the architecture of, the security and privacy-related audits and certifications received for, and the administrative, technical and physical controls applicable to the services branded as AgilePoint NX OnDemand.
MDM Deployment Guide	This document gives MDM deployment procedures for apps created with the Mobile App Accelerator.
Accessibility Conformance, v8.0 Software Update 1	This document gives information about Section 508 and WCAG compliance for AgilePoint NX.