Introducing the Alloy Navigator Express API

The Alloy Navigator Express API module provides integration capabilities for third-party applications. Using the API, you can make various apps work with Alloy Navigator Express objects and perform workflow actions. It is important to understand that, unlike most other APIs, Alloy API does not create or update objects directly. It uses workflow actions instead.

The API module is the middleman between third-party applications and Alloy Navigator Express. When a user initiates an API call via the third-party app, the API responds by executing workflow actions or fetching the requested data. Using workflow , the API provides the ability to create new object records. Using workflow Actions, it updates various objects. If the application sends the request for information about particular objects, classification values or the current user, the API retrieves relevant data from the database and sends it back to the third-party application.

The Alloy Navigator Express API offers the functionality similar to what you can find in the Web App or Desktop App:

Function

Method Endpoint

Authenticating the User

POST

/api/token

Retrieving Information about the Current User

GET

/api/v2/object/profile

Listing Objects

GET(POST)

/api/v2/<objectClass>

Obtaining Information About Objects

GET

/api/v2/object/<oid>

Obtaining Object Activities

GET (POST)

/api/v2/Activities/<oid>

Obtaining Object Classification Values

GET (POST)

/api/v2/Dictionary

Creating Objects

POST

/api/v2

Updating Objects with Step Actions

POST

/api/v2/object/<oid>/action/<actionId>

Checking Step Action Availability

GET

/api/v2/object/<oid>/action/<actionId>/check

INFO: For the list of supported objects, see Supported Alloy Navigator Express Object Classes.

Document Audience

This document targets system administrators and software engineers who will configure third-party applications to interact with Alloy Navigator Express.

This guide assumes that you are familiar with other Alloy Navigator Express product documentation and have a basic understanding of web technologies, including the HTTP protocol, JSON, and XML.