API Core

The API core implements the core functionality for EQuIS Enterprise (e.g., Widgets, EDP Workflow, Reporting). Specific resources within the API.Core are defined below. See the Swagger documentation for details.

api/config – Manage application configuration data in ST_CONFIG table. Many of these endpoints require Administrator rights.

api/dashboard – Used by the Enterprise web application to manage dashboards and widgets.

api/download – Access BLOB data stored in the DT_FILE, ST_NOTICE_ATTACHMENT, ST_FILE_REGISTRATION, SDT_DASHBOARD, and SDT_WIDGET_TYPE tables.

api/edp – Enterprise EDP and EDD access.

api/eia – Management of Enterprise EQuIS Information Agents (EIAs).

api/explorer – Ported from EQuIS 6 to facilitate the Explorer widget. Some aspects are not RESTful.

api/facilities – Facility and Location objects with support for Esri mapping services. Some aspects are not RESTful by design to support Esri’s API. The Samples and Tests routes are not implemented yet.

api/files – Management of data in the DT_FILE table. See below for an example of how to upload files using the EQuIS REST API POST api/files endpoint.

api/formats – Management of EDP format registration used by Enterprise EDP.

api/groups – Management of group data in RT_GROUP and RT_GROUP_MEMBER.

api/logs – Management of data in the ST_LOG table. It does not provide access to other Log4Net file appenders.

api/modules – Management of EQuIS Product module information with limited deployment support.

api/notes – Management of note records.

api/notices – Management of EQuIS notifications.

api/odata – OData implementation (as of the 7.20.3 Build). Requires ALS role membership.

api/refvals – Read-only access to Reference Values.

api/registration – License registration and use.

api/reports – Access to EQuIS Reporting capabilities.

api/spm – Management of Sample Planning Module plans and tasks.

api/token – Authentication token management.

api/users – Administrator access to user management and non-admin user profile management.

api/workflow – EQuIS Enterprise Workflow configuration and management.

Examples

Example 1: Create a File Using POST /api/files

To upload files using the EQuIS REST API, create an authenticated POST request to api/files with a File object as the content. The user performing this request must have Creator permission on the File object type, and optionally would need editor permissions on the file's FacilityId if that value is set.

The file content can be provided in either the content or external_url fields, but at least one of them must be set. Otherwise, the request will result in a 400 Bad Request.

Below is an example request body:

{

"file_type": ".txt", //This value must have an associated RT_FILE_TYPE.FILE_TYPE value.

"facility_id": null, //The optional ID of the facility.

"place_type": null, //In order to associate a file with a location, this field needs to be set to "sys_loc_code".

"place_code": null, //In order to associate a file with a location, this field needs to be set to the sys_loc_code of the location (ex. "B-30").

"place_subcode": null,

"file_date": "1641591000000", //A Javascript timestamp representation of the date.

"confidential_yn": "N",

"external_url": null, //The URL of where the file is stored. The URL must be accessible from where EQuIS Enterprise is hosted (ex. "http://www.mydomain.com/myfile.txt").

"title": "This is a test file",

"author": null,

"file_parameters": [],

"content": [116, 101, 115, 116], //A byte array representing the file content.

"id": -1, //This is a required field and should be set to a negative number. The ID will be assigned when the file record is created. The response will contain the file ID.

"code": null,

"objectType": 16, //This is a required field which identifies this object type. The value 16 corresponds to an object type of file.

"remark": null,

"owner": "username", //The name of the user associated with the file

"name": "myfile.txt",

"tag": null,

}

EQuIS REST API Core

EQuIS REST API Core