iMIS SDK

iMIS SDK Developer Guide

The iMIS software development kit (SDK) provides a secure set of web services for accessing the iMIS platform, across the organization, across different physical locations, and even across organizational boundaries.

This documentation contains the following sections and supports iMIS versions 20.2.26 (iMIS 20-300), 100.1.65 (iMIS 20-100 and iMIS 20-200), and later versions, unless a specific environment is specified.

Get Started    Discussions
Suggest Edits

Intelligent Query Architect

 

The Intelligent Query Architect (IQA) is the foundation for searches, lists, and data for reporting throughout iMIS.

To run Try It examples from this site, a valid Bearer access_token is required.

Create Token

Suggest Edits

Query results

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo/api/iqa
jQuery.ajax("https://myserver.com/api/iqa?QueryName=$/Common/Queries/Search/Contact/Last Name&parameter=eq:smith", {
  type: "GET",
  contentType: "application/json",
  headers: {
    RequestVerificationToken: document.getElementById(
      "__RequestVerificationToken"
    ).value
  },
  success: function(data) {
    console.log(data);
  }
});
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

queryname
string
required

IQA Query path "$/Common/Queries/Search/Contact/Last Name"

parameter
string

Filter parameter value "eq:smith"

limit
int32
 

Tip: Multiple Parameters

:bulb+: If an IQA has multiple parameters, each one (including optional parameters) must be specified in order, in the query string, based on the IQA definition. You call the endpoint by duplicating the same "&parameter=" parameter for each one.

For example, for an IQA that takes three optional parameters for firstName, lastName, and email, you would call the URL like:

/api/iqa?QueryPath=$/TestQuery&Parameter=&Parameter=smith&Parameter=smith@example.org

Suggest Edits

Query by key

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://testapi.imis.com/Asi.Scheduler_SDKDemo
jQuery.ajax("https://myserver.com/api/iqa?querydocumentversionkey=5DE3FE0D-565C-4BB7-90F0-F8AC4C921422", {
  type: "GET",
  contentType: "application/json",
  headers: {
    RequestVerificationToken: document.getElementById(
      "__RequestVerificationToken"
    ).value
  },
  success: function(data) {
    console.log(data);
  }
});
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Query Params

querydocumentversionkey
string
required

Document version key "5DE3FE0D-565C-4BB7-90F0-F8AC4C921422"

limit
int32