Working with ITAS APIs

Overview

Working directly with ITAS API, Data Query Service or Data Modify Service is different to working with the Events API. Security is enforced using an OWIN token rather than an HMAC algorithm, the URL architecture is based around the ITAS Data Entities and the request bodies are more flexible since we are working with dynamic data stores.

Useful Links

Please review the articles located here to gain an understanding of how to use to the (v2) APIs below, in particular the header information required when making a request.

Depending on licencing, the APIs available are:

API

Plan

HTTP

HTTPS

Description

Events *

E

4710

5710

Alerts and Notifications triggered by events in ITAS processes

ITAS API

E

4720

5720

Set of REST endpoints available for defined data flows (e.g. cash management) - see library

Web Portal 

P

4726

5726

Access to ITAS data and functions via browser (v1)

Data Portal

C

4727

5727

AKA Web Portal v2; access to Data, Documents and Reports

Client Services

E

4730

5730

Includes DQS (library), DMS (library) for data management projects 

Workflow

P

4740

5740

Managed processes based on IFTTT template

Authorisation

C

4750

5750

Centralised user authorisation **

OData Service

P

4760

5760

OData feed providing access to Data Entities and ITASreports to Excel/PowerBI users

Document Services

E

4770

5770

Access to documents/metadata stored in Windows and FileStream Database

Graph Services ***

P

4780

5780

Access to Microsoft O365 Platform via MS Graph API

 

* Consolidated endpoints from v1 (port 81) applying a number of performance improvements as well as reducing the number of calls required to receive a message

** Combined with the Policy Framework forms the backbone of Identity Server

*** Included in 8.15

When working with DQS/DMS access is provided to the Data Entities themselves; naming conventions and property attributes can be reviewed locally (http://your.server.name:4731/#/dqs)


Was this helpful?
Thanks for your feedback