Web Services API

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.

Video: Show Data from a Web Service on an eForm

Examples in the AgilePoint NX Product Documentation

AgilePoint NX Product Documentation provides basic examples for common use cases, general procedures, and functionality that is native to AgilePoint NX. Other resources from AgilePoint or third-party vendors may provide more specific examples to meet your needs.

  • Common Use Case Examples for AgilePoint NX Portal

    Most examples that are provided in the Product Documentation for AgilePoint NX Portal are related to the most common types of use cases.

    • Examples - Step-by-step walkthroughs for the most common types of use cases in AgilePoint NX.

      New examples are added to this section each time the Product Documentation is updated.

    • Field input values - Whenever feasible, the Product Documentation provides example input values for fields in the AgilePoint NX Portal UI. However, not every field definition provides an example. Sometimes, examples are simply missing, and in these cases, they are added when identified.

      However, there are many cases where examples are intentionally omitted. These include:

      • Fields are too general to provide useful sample values. Examples include Name and Description fields, which are simply open-ended text labels.
      • Fields where the input values are variables. Variable names depend on your data model, and they are added through drag-and-drop. Example values are usually not useful for these fields.
      • Field values for third-party integrations. For more information, refer to Documentation for Third-Party Integrations in this list.
  • Basic Code Examples
    For examples related to writing software code to extend or integrate with AgilePoint NX, refer to these resources:
  • Advanced Examples

    For more advanced or complex examples or specific information about how to solve a specific business problem or use case, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An 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.
    • Video Portal - Video walkthroughs for a range of simple and advanced tasks in AgilePoint NX.
    • 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.
  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An 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.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

PDFs

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

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).

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.

Governance Guide

This document describes the governance process for AgilePoint NX.

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.

Upgrade Guide

This document provides instructions to upgrade AgilePoint.

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

This document gives information about Section 508 and WCAG compliance for AgilePoint NX.