{"info":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","description":"

Overview

eMaint X4 API v2 extends the capabilities of the original API:

generated access tokens are now in JWT format
\n
new web methods extends the capabilities of the API
\n
proper status codes returned
\n
response format now being driven by Accept header variable
\n
/GetAnyData now supports joining to related tables
\n

Whom is this document for?

Developers

Status Codes

HTTP Status Codes with their definitions

Success Codes

The following status codes are expected whenever the request is successfully processed.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Text	Description
200	OK	The request has succeeded.
201	Created	The request has been fulfilled and has resulted in one or more new resources being created.

Error Codes

The following status codes are expected whenever the request fails. Some requests try to operate over multiple entities and/or multiple records - in this scenario error response code is returned if the operation fails to at least one of the items in the submitted payload.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Text	Description
400	Bad Request	The server cannot or will not process the request due to something that is perceived to be a client error
401	Unauthorized	The request has not been applied because it lacks valid authentication credentials for the target resource.
404	Not Found	The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
405	Not Allowed	The method is not yet implemented or is not allowed
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request.
503	Service Unavailable	The server is not ready to handle the request.

Media Types

The following list describes all media types supported by the eMaint X4 API v2.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Type Name	Description
application/json	Supported as content-type as well as accepted output
application/xml	Supported as accepted output only

Authentication

This API supports two authentication schemes: HTTP Basic Authentication and JWT Token Authentication.

HTTP Basic Authentication

HTTP Basic Authentication can be used for non-interactive machine-to-machine communication with eMaint X4.

To setup HTTP Basic Authentication include the standard Authorization HTTP header in every request:

Authorization: Basic <token>\n\n

Where is : encoded in Base64.

For example for:

    username: jsmith\n    password: secret    \n\n

The raw (unencoded) is: jsmith:secret and the resuting Authorization header is:

Authorization: Basic *******************\n\n

JWT Token Authentication

Authentication with JWT token is more secure and also can be used for non-interactive machine-to-machine communication with eMaint X4. Generated tokens are valid for 7 days and are paired with the Xt-UserAgent header variable that was used to generate the token. Therefore you have to always specify not just the token but also the same Xt-UserAgent in the header of each subsequent API call.

Contact Support:
Email: support@emaint.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Whom is this document for?","slug":"whom-is-this-document-for"},{"content":"Status Codes","slug":"status-codes"},{"content":"Media Types","slug":"media-types"},{"content":"Authentication","slug":"authentication"}],"owner":"17558505","collectionId":"920169ff-5dd3-4a7f-8537-fff78cc25514","publishedId":"2sB2j3Ar6b","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-05-07T13:01:41.000Z"},"item":[{"name":"Generate Auth Token","item":[{"name":"with JWT Token","id":"23ead119-5d20-40ca-80dc-b7e21f426614","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"username","value":"","description":"

(Required) The user name for login

\n"},{"key":"password","value":"","description":"

(Required) The password for login in clear text

\n"},{"key":"XT-UserAgent","value":"","description":"

(Required) free text, the login token generated would be mapped to the user agent specified; same user agent id must present in subsequent calls

\n"}],"url":"https://x46.emaint.com/api/v2/GetLoginToken","description":"

GetLoginToken may be called from any server in the same environment, but all other methods must be called from the server provided in the “serverUrl” value. Use this token as part of request Authorization header for subsequent requests

Description

Return the result of a query based on parameters passed which defines:

Table name
\n
Columns listed
\n
Filter applied
\n
Sorted columns and directions
\n
Page number
\n
Join to related tables
\n
Group by clause
\n
Page size (must be used in combination with Page number)
\n
Offset
\n
Count (must be used in combination with Offset)
\n
Object Structure ID (advanced usage)
\n

Remarks

Object structure metadata can be specified as a header variable output-data-structure . The value must be stringified JSON string.
\n
If you specify columns and objectId , the columns property is getting ignored
\n
limiting the number of records returned is done either with pageNumber and pageSize or with offset and count
\n

How to filter the amount of data returned?

There are few ways to filter the amount of data to return via /GetAnyData API call:

using a filter
\n
page number and page size
\n
offset and count
\n

To filter out the data you wish to extract from your database you have to know the criteria you want to use. For example, in Work Orders table you may want to collect information about the \"open\" work orders only. Therefore, your filter will look like this:

\"filter\": {\n    \"logic\": \"and\",\n    \"filters\": [\n        {\n            \"field\": \"WORKSTATUS\",\n            \"operator\": \"eq\",\n            \"value\": \"O\"\n        }\n    ]\n}\n\n

The main property is called filter and contains the logic (AND or OR) and the criteria listed in filters array. The filters array may contain multiple clauses combined according to the logic selected.

Operators

equal to - eq, ==
\n
not equal to - neq, !=
\n
is greater than - gt, >
\n
is greater than or equal to - gte, >=
\n
is less than - lt, <
\n
is less than or equal to - lte, <
\n
value starts with - startswith
\n
value not starts with - notstartswith
\n
value ends with - endswith
\n
value not ends with - notendswith
\n
value contains - contains
\n
value does not contain - notcontains
\n
value contain at least one of the provided words - containany
\n
- example: \"first second third\" - will return records which contain \"first\" or \"second\" or \"third\" word
\n
value contain all provided words
\n
- example \"first second third\" - will return records which contain all words in any order, i.e \"second any third and first\" will be found
\n
value is empty - isempty
\n
value is not empty - notisempty
\n
value is null - isnull
\n
value is not null - notisnull
\n
is between provided value and value2 - between
\n
is not between provided value and value2 - notbetween
\n

How to join 2 tables together?

To join 2 tables together add join property to the payload. The main table is then joined to the table you provide into the property. There are 3 types of joins supported:

LEFT - retrieves all records from the main table and the matched records from the \"joined\" table, returning NULL values for unmatched records in the joined table
\n
INNER - retrieves only the matched records between the main table table and the \"joined\" table
\n
RIGHT - retrieves all records from the joined table and the matched records from the left table, returning NULL values for unmatched records in the main table
The joined table is matched according to the predefined relationship in Data Dictionary.
\n

Usage exmple:

\"join\": {\n    \"joinwith\": [\n        {\n            \"dd_dbf\": \"WORK\",\n            \"jointype\": \"INNER\"\n        }\n    ]\n}\n\n

\n","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}},"urlObject":{"path":["getAnyData"],"host":["https://x46.emaint.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"5e7560ee-8b60-4497-aaf7-4ebdd4cbf77b","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","description":"Added as a part of security scheme: bearer"},{"key":"output-data-structure","value":"{\"joinwith\":[{\"columns\":[{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"BUILDING\"},{\"name\":\"FLR_LEVEL\"},{\"name\":\"ROOM_SPCE\"}],\"dd_dbf\":\"COMPINFO\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"LAB\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"FULLNAME\"},{\"name\":\"EMAIL\"}],\"dd_dbf\":\"CONTACT\"}],\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"TRANDATE\"},{\"name\":\"LAB_START\"},{\"name\":\"COMMENT\"},{\"name\":\"LAB_STOP\"},{\"name\":\"QTY\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"LABTRANS\",\"dd_dbf\":\"CHARGES\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"MAT\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"DESCRIP\"}],\"dd_dbf\":\"ARINVT01\"},{\"columns\":[{\"name\":\"INV_NO\"},{\"name\":\"INVLOC\"}],\"dd_dbf\":\"ICJOURNL\"}],\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"CATEGORY\"},{\"name\":\"TRANDATE\"},{\"name\":\"ADDUSER\"},{\"name\":\"INVLOC\"},{\"name\":\"UNITCOST\"},{\"name\":\"QTY\"},{\"name\":\"COMMENT\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"MATUSETRANS\",\"dd_dbf\":\"CHARGES\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"TASK_DESC\"},{\"name\":\"TASKTEXT\"},{\"name\":\"STATUS\"},{\"name\":\"COMPID\"},{\"name\":\"WO\"},{\"name\":\"TASK_NO\"},{\"name\":\"READING\"},{\"name\":\"PROC_SEQ\"},{\"name\":\"CMWO\"},{\"name\":\"PFNARADIO\"},{\"name\":\"SCHADASSID\"}],\"dd_dbf\":\"WO_PROCS\"},{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"DATE_SCH\"},{\"name\":\"STATUS\"},{\"name\":\"CUID\"},{\"name\":\"EST_HOURS\"},{\"name\":\"SCHADASSID\"},{\"name\":\"SIGNEDON\"}],\"alias\":\"ASSIGNMENT\",\"dd_dbf\":\"WOASSIGN\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"SCHADASSID\"},{\"name\":\"CDESC\"},{\"name\":\"MLINK\"}],\"alias\":\"DOCUMENTS\",\"dd_dbf\":\"WO_DOCS\"}],\"columns\":[{\"name\":\"WO\"},{\"name\":\"BRIEF_DESC\"},{\"name\":\"WORK_DESC\"},{\"name\":\"DATE_WO\"},{\"name\":\"TIME\"},{\"name\":\"WORKSTATUS\"},{\"name\":\"WO_TYPE\"},{\"name\":\"SCH_DATE\"},{\"name\":\"DATE_CMPL\"},{\"name\":\"PRIORITY\"},{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"DEPARTMENT\"},{\"name\":\"ADDUSER\"}]}","description":"stringified JSON format expected","disabled":true},{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"POSTMAN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table\": \"WORK\",\n \"columns\": \"WO,WO_TYPE,DATE_WO,ADDDATE,TIME,ADDUSER,COMPID\",\n \"filter\": {\n \"logic\": \"and\",\n \"filters\": [\n {\n \"field\": \"WO_TYPE\",\n \"operator\": \"neq\",\n \"value\": \"PM\"\n }\n ]\n },\n \"sortBy\": [\n {\n \"field\": \"compid\",\n \"dir\": \"desc\"\n }\n ],\n \"count\": 10,\n \"offset\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://x42.emaint.com/api/v2/getAnyData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": true,\n \"message\": \"\",\n \"data\": {\n \"WORK\": [\n {\n \"WO\": \"742\",\n \"BRIEF_DESC\": \"CONVEYOR BELT GENERAL INSPECTION\",\n \"WORK_DESC\": \"\",\n \"DATE_WO\": \"2017-11-13T00:00:00.000Z\",\n \"WORKSTATUS\": \"COMPLETE\",\n \"WO_TYPE\": \"PM\",\n \"COMPINFO\": {\n \"COMPID\": \"HL11150\",\n \"COMP_DESC\": \"Filler Empty Bottle Infeed Screw Conveyor\",\n \"BUILDING\": \"Main\",\n \"FLR_LEVEL\": \"Ground\",\n \"ROOM_SPCE\": \"100\"\n },\n \"WO_PROCS\": {\n \"data\": [\n {\n \"CUID\": \"_54D0I4U5K\",\n \"TASK_DESC\": \"A-1 Air Dryer, Refrigerated or Regenerative\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-1\",\n \"PROC_SEQ\": \"1\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n },\n {\n \"CUID\": \"_54D0I5B9V\",\n \"TASK_DESC\": \"A-2 Unitary, Heating and Cooling Unit\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"On Hold\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-2\",\n \"PROC_SEQ\": \"2\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n }\n ],\n \"ASSIGNMENT\": {\n \"data\": [\n {\n \"CONTACTID\": \"BWDEMO\",\n \"DATE_SCH\": \"2017-12-10T00:00:00.000Z\",\n \"STATUS\": \"ASSIGNED\",\n \"CUID\": \"_52404S6OA\",\n \"EST_HOURS\": \"0.00\",\n \"SCHADASSID\": \"\",\n \"SIGNEDON\": \"\"\n }\n ]\n },\n \"DOCUMENTS\": {\n \"data\": []\n }\n }\n }\n ]\n }\n}"},{"id":"cf26306a-f8b2-41cb-95d8-2efef6604c0a","name":"My Open Work Orders - Basic example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","description":"Added as a part of security scheme: bearer"},{"key":"output-data-structure","value":"{\"joinwith\":[{\"columns\":[{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"BUILDING\"},{\"name\":\"FLR_LEVEL\"},{\"name\":\"ROOM_SPCE\"}],\"dd_dbf\":\"COMPINFO\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"LAB\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"FULLNAME\"},{\"name\":\"EMAIL\"}],\"dd_dbf\":\"CONTACT\"}],\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"TRANDATE\"},{\"name\":\"LAB_START\"},{\"name\":\"COMMENT\"},{\"name\":\"LAB_STOP\"},{\"name\":\"QTY\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"LABTRANS\",\"dd_dbf\":\"CHARGES\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"MAT\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"DESCRIP\"}],\"dd_dbf\":\"ARINVT01\"},{\"columns\":[{\"name\":\"INV_NO\"},{\"name\":\"INVLOC\"}],\"dd_dbf\":\"ICJOURNL\"}],\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"CATEGORY\"},{\"name\":\"TRANDATE\"},{\"name\":\"ADDUSER\"},{\"name\":\"INVLOC\"},{\"name\":\"UNITCOST\"},{\"name\":\"QTY\"},{\"name\":\"COMMENT\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"MATUSETRANS\",\"dd_dbf\":\"CHARGES\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"TASK_DESC\"},{\"name\":\"TASKTEXT\"},{\"name\":\"STATUS\"},{\"name\":\"COMPID\"},{\"name\":\"WO\"},{\"name\":\"TASK_NO\"},{\"name\":\"READING\"},{\"name\":\"PROC_SEQ\"},{\"name\":\"CMWO\"},{\"name\":\"PFNARADIO\"},{\"name\":\"SCHADASSID\"}],\"dd_dbf\":\"WO_PROCS\"},{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"DATE_SCH\"},{\"name\":\"STATUS\"},{\"name\":\"CUID\"},{\"name\":\"EST_HOURS\"},{\"name\":\"SCHADASSID\"},{\"name\":\"SIGNEDON\"}],\"alias\":\"ASSIGNMENT\",\"dd_dbf\":\"WOASSIGN\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"SCHADASSID\"},{\"name\":\"CDESC\"},{\"name\":\"MLINK\"}],\"alias\":\"DOCUMENTS\",\"dd_dbf\":\"WO_DOCS\"}],\"columns\":[{\"name\":\"WO\"},{\"name\":\"BRIEF_DESC\"},{\"name\":\"WORK_DESC\"},{\"name\":\"DATE_WO\"},{\"name\":\"TIME\"},{\"name\":\"WORKSTATUS\"},{\"name\":\"WO_TYPE\"},{\"name\":\"SCH_DATE\"},{\"name\":\"DATE_CMPL\"},{\"name\":\"PRIORITY\"},{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"DEPARTMENT\"},{\"name\":\"ADDUSER\"}]}","description":"stringified JSON format expected","disabled":true},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"table\": \"WORK\",\n \"columns\": \"WO,WO_TYPE,DATE_WO,BRIEF_DESC,COMPID,COMP_DESC,STATTYPE\",\n \"filter\": {\n \"logic\": \"and\",\n \"filters\": [\n {\n \"field\": \"WORKSTATUS\",\n \"operator\": \"eq\",\n \"value\": \"O\"\n },\n { \n \"field\": \"assignto\",\n \"operator\": \"eq\",\n \"value\": \"John Dow\"\n }\n ]\n },\n \"sortBy\": [\n {\n \"field\": \"wo\",\n \"dir\": \"desc\"\n }\n ],\n \"pageNumber\": 1,\n \"pageSize\": 100\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/api/v2/getAnyData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": true,\n \"message\": \"\",\n \"data\": {\n \"WORK\": [\n {\n \"WO\": \"742\",\n \"WO_TYPE\": \"PM\",\n \"DATE_WO\": \"2017-11-13T00:00:00.000Z\",\n \"BRIEF_DESC\": \"CONVEYOR BELT GENERAL INSPECTION\",\n \"COMPID\": \"1000\",\n \"COMP_DESC\": \"MOTOR\", \n \"STATTYPE\": \"COMPLETE\" \n }\n ]\n }\n}"},{"id":"bd56626f-931f-48ed-bf15-536a46c34665","name":"Query with filter, join and group by clauses","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"},{"key":"output-data-structure","value":"{{JSON}}","description":"stringified JSON format expected","disabled":true},{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"POSTMAN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table\": \"CHARGES\",\n \"columns\": \"CHARGES.WO, SUM(QTY) as qty, SUM(EXTCOST) as extcost\",\n \"pageNumber\": 1,\n \"pageSize\": 1000,\n \"filter\": {\n \"logic\": \"and\",\n \"filters\": [\n {\n \"field\": \"ctype\",\n \"operator\": \"eq\",\n \"value\": \"MAT\"\n },\n { \n \"field\": \"WORK__WORKSTATUS\",\n \"operator\": \"eq\",\n \"value\": \"O\"\n }\n ]\n },\n \"join\": {\n \"joinwith\": [\n {\n \"dd_dbf\": \"WORK\",\n \"jointype\": \"INNER\"\n }\n ]\n },\n \"sortBy\": [\n {\n \"field\": \"trandate\",\n \"dir\": \"desc\"\n }\n ],\n \"groupBy\": [\n {\n \"field\": \"work.wo\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/getAnyData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": true,\n \"message\": \"\",\n \"data\": {\n \"WORK\": [\n {\n \"WO\": \"742\",\n \"BRIEF_DESC\": \"CONVEYOR BELT GENERAL INSPECTION\",\n \"WORK_DESC\": \"\",\n \"DATE_WO\": \"2017-11-13T00:00:00.000Z\",\n \"WORKSTATUS\": \"COMPLETE\",\n \"WO_TYPE\": \"PM\",\n \"COMPINFO\": {\n \"COMPID\": \"HL11150\",\n \"COMP_DESC\": \"Filler Empty Bottle Infeed Screw Conveyor\",\n \"BUILDING\": \"Main\",\n \"FLR_LEVEL\": \"Ground\",\n \"ROOM_SPCE\": \"100\"\n },\n \"WO_PROCS\": {\n \"data\": [\n {\n \"CUID\": \"_54D0I4U5K\",\n \"TASK_DESC\": \"A-1 Air Dryer, Refrigerated or Regenerative\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-1\",\n \"PROC_SEQ\": \"1\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n },\n {\n \"CUID\": \"_54D0I5B9V\",\n \"TASK_DESC\": \"A-2 Unitary, Heating and Cooling Unit\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"On Hold\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-2\",\n \"PROC_SEQ\": \"2\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n }\n ],\n \"ASSIGNMENT\": {\n \"data\": [\n {\n \"CONTACTID\": \"BWDEMO\",\n \"DATE_SCH\": \"2017-12-10T00:00:00.000Z\",\n \"STATUS\": \"ASSIGNED\",\n \"CUID\": \"_52404S6OA\",\n \"EST_HOURS\": \"0.00\",\n \"SCHADASSID\": \"\",\n \"SIGNEDON\": \"\"\n }\n ]\n },\n \"DOCUMENTS\": {\n \"data\": []\n }\n }\n }\n ]\n }\n}"},{"id":"f1626de8-5562-4d41-9782-38ee4c4cee5c","name":"Query with complex object structure in response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","description":"Added as a part of security scheme: bearer"},{"key":"output-data-structure","value":"{\"joinwith\":[{\"columns\":[{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"BUILDING\"},{\"name\":\"FLR_LEVEL\"},{\"name\":\"ROOM_SPCE\"}],\"dd_dbf\":\"COMPINFO\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"LAB\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"FULLNAME\"},{\"name\":\"EMAIL\"}],\"dd_dbf\":\"CONTACT\"}],\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"TRANDATE\"},{\"name\":\"LAB_START\"},{\"name\":\"COMMENT\"},{\"name\":\"LAB_STOP\"},{\"name\":\"QTY\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"LABTRANS\",\"dd_dbf\":\"CHARGES\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"MAT\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"DESCRIP\"}],\"dd_dbf\":\"ARINVT01\"},{\"columns\":[{\"name\":\"INV_NO\"},{\"name\":\"INVLOC\"}],\"dd_dbf\":\"ICJOURNL\"}],\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"CATEGORY\"},{\"name\":\"TRANDATE\"},{\"name\":\"ADDUSER\"},{\"name\":\"INVLOC\"},{\"name\":\"UNITCOST\"},{\"name\":\"QTY\"},{\"name\":\"COMMENT\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"MATUSETRANS\",\"dd_dbf\":\"CHARGES\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"TASK_DESC\"},{\"name\":\"TASKTEXT\"},{\"name\":\"STATUS\"},{\"name\":\"COMPID\"},{\"name\":\"WO\"},{\"name\":\"TASK_NO\"},{\"name\":\"READING\"},{\"name\":\"PROC_SEQ\"},{\"name\":\"CMWO\"},{\"name\":\"PFNARADIO\"},{\"name\":\"SCHADASSID\"}],\"dd_dbf\":\"WO_PROCS\"},{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"DATE_SCH\"},{\"name\":\"STATUS\"},{\"name\":\"CUID\"},{\"name\":\"EST_HOURS\"},{\"name\":\"SCHADASSID\"},{\"name\":\"SIGNEDON\"}],\"alias\":\"ASSIGNMENT\",\"dd_dbf\":\"WOASSIGN\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"SCHADASSID\"},{\"name\":\"CDESC\"},{\"name\":\"MLINK\"}],\"alias\":\"DOCUMENTS\",\"dd_dbf\":\"WO_DOCS\"}],\"columns\":[{\"name\":\"WO\"},{\"name\":\"BRIEF_DESC\"},{\"name\":\"WORK_DESC\"},{\"name\":\"DATE_WO\"},{\"name\":\"TIME\"},{\"name\":\"WORKSTATUS\"},{\"name\":\"WO_TYPE\"},{\"name\":\"SCH_DATE\"},{\"name\":\"DATE_CMPL\"},{\"name\":\"PRIORITY\"},{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"DEPARTMENT\"},{\"name\":\"ADDUSER\"}]}","description":"stringified JSON format expected"},{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"POSTMAN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table\": \"WORK\", \n \"pageNumber\": 1,\n \"pageSize\": 10,\n \"filter\": {\n \"logic\": \"and\",\n \"filters\": [ \n { \n \"field\": \"WORK__WORKSTATUS\",\n \"operator\": \"eq\",\n \"value\": \"O\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/getAnyData"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": true,\n \"message\": \"\",\n \"data\": {\n \"WORK\": [\n {\n \"WO\": \"742\",\n \"BRIEF_DESC\": \"CONVEYOR BELT GENERAL INSPECTION\",\n \"WORK_DESC\": \"\",\n \"DATE_WO\": \"2017-11-13T00:00:00.000Z\",\n \"WORKSTATUS\": \"COMPLETE\",\n \"WO_TYPE\": \"PM\",\n \"COMPINFO\": {\n \"COMPID\": \"HL11150\",\n \"COMP_DESC\": \"Filler Empty Bottle Infeed Screw Conveyor\",\n \"BUILDING\": \"Main\",\n \"FLR_LEVEL\": \"Ground\",\n \"ROOM_SPCE\": \"100\"\n },\n \"WO_PROCS\": {\n \"data\": [\n {\n \"CUID\": \"_54D0I4U5K\",\n \"TASK_DESC\": \"A-1 Air Dryer, Refrigerated or Regenerative\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-1\",\n \"PROC_SEQ\": \"1\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n },\n {\n \"CUID\": \"_54D0I5B9V\",\n \"TASK_DESC\": \"A-2 Unitary, Heating and Cooling Unit\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"On Hold\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-2\",\n \"PROC_SEQ\": \"2\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n }\n ],\n \"ASSIGNMENT\": {\n \"data\": [\n {\n \"CONTACTID\": \"BWDEMO\",\n \"DATE_SCH\": \"2017-12-10T00:00:00.000Z\",\n \"STATUS\": \"ASSIGNED\",\n \"CUID\": \"_52404S6OA\",\n \"EST_HOURS\": \"0.00\",\n \"SCHADASSID\": \"\",\n \"SIGNEDON\": \"\"\n }\n ]\n },\n \"DOCUMENTS\": {\n \"data\": []\n }\n }\n }\n ]\n }\n}"},{"id":"574cc8d5-d956-4184-812f-8e6d363600f4","name":"Unable to complete the operation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"POSTMAN","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table\": \"WORK\",\n \"filter\": {\n \"logic\": \"and\",\n \"filters\": [\n {\n \"field\": \"WO_TYPE\",\n \"operator\": \"neq\",\n \"value\": \"PM\"\n },\n {\n \"table\": \"compinfo\",\n \"field\": \"comp_desc\",\n \"operator\": \"startswith\",\n \"value\": \"A\"\n }\n ]\n },\n \"join\": {\n \"joinwith\": [\n {\n \"dd_dbf\": \"COMPINFO\"\n }\n ]\n },\n \"sortBy\": [\n {\n \"field\": \"compid1\",\n \"dir\": \"desc\"\n }\n ],\n \"pageNumber\": 1,\n \"pageSize\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/getAnyData"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"Page number must be higher than zero.\"\n}"},{"id":"b7247c49-fe99-4678-89e4-01ad97818ee2","name":"Authentication failure","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"BAD_AGENT","type":"text"}],"body":{"mode":"raw","raw":"{\n \"table\": \"WORK\",\n \"columns\": \"WO, WO_TYPE\",\n \"filter\": {\n \"logic\": \"and\",\n \"filters\": [\n {\n \"field\": \"WO_TYPE\",\n \"operator\": \"eq\",\n \"value\": \"PM\"\n },\n {\n \"table\": \"compinfo\",\n \"field\": \"comp_desc\",\n \"operator\": \"notstartswith\",\n \"value\": \"A\"\n }\n ]\n },\n \"join\": {\n \"joinwith\": [\n {\n \"dd_dbf\": \"COMPINFO\"\n }\n ]\n },\n \"sortBy\": [\n {\n \"field\": \"compid\",\n \"dir\": \"desc\"\n }\n ],\n \"pageNumber\": 1,\n \"pageSize\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/getAnyData"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"Authentication failure\"\n}"}],"_postman_id":"308d25fb-f0b8-40f9-b708-62dcbaffc84f"},{"name":"Get record with nested data (advanced)","id":"da28ccdb-2e2b-454e-a15a-9931937df368","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"POSTMAN"},{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","type":"text"}],"url":"https://x46.emaint.com/api/v2/getObjectData?table=WORK&keyvalue=120&objectid=WO_WO","description":"

Use this method to obtain record data along with related information in a complex nested JSON/XML structure

(Required) Table identifier

\n","type":"text/plain"},"key":"table","value":"WORK"},{"description":{"content":"

(Required) Record identifier

\n","type":"text/plain"},"key":"keyvalue","value":"120"},{"description":{"content":"

(Required) Object structure identifier

\n","type":"text/plain"},"key":"objectid","value":"WO_WO"}],"variable":[]}},"response":[{"id":"7f537bc4-8b1a-40ff-b0d6-ffee68acab0c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"XT-UserAgent","value":"POSTMAN","type":"text"},{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","type":"text"}],"url":{"raw":"https://x46.emaint.com/api/v2/getObjectData?table=WORK&keyvalue=120&objectid=WO_WO","host":["https://x46.emaint.com/api/v2"],"path":["getObjectData"],"query":[{"key":"table","value":"WORK"},{"key":"keyvalue","value":"120"},{"key":"objectid","value":"WO_WO"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": true,\n \"message\": \"\",\n \"data\": {\n \"WORK\": {\n \"WO\": \"742\",\n \"BRIEF_DESC\": \"CONVEYOR BELT GENERAL INSPECTION\",\n \"WORK_DESC\": \"\",\n \"DATE_WO\": \"2017-11-13T00:00:00.000Z\",\n \"WORKSTATUS\": \"COMPLETE\",\n \"WO_TYPE\": \"PM\",\n \"COMPINFO\": {\n \"COMPID\": \"HL11150\",\n \"COMP_DESC\": \"Filler Empty Bottle Infeed Screw Conveyor\",\n \"BUILDING\": \"Main\",\n \"FLR_LEVEL\": \"Ground\",\n \"ROOM_SPCE\": \"100\"\n },\n \"WO_PROCS\": {\n \"data\": [\n {\n \"CUID\": \"_54D0I4U5K\",\n \"TASK_DESC\": \"A-1 Air Dryer, Refrigerated or Regenerative\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-1\",\n \"PROC_SEQ\": \"1\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n },\n {\n \"CUID\": \"_54D0I5B9V\",\n \"TASK_DESC\": \"A-2 Unitary, Heating and Cooling Unit\",\n \"TASKTEXT\": \"\",\n \"STATUS\": \"On Hold\",\n \"COMPID\": \"\",\n \"WO\": \"742\",\n \"READING\": \"\",\n \"TASK_NO\": \"A-2\",\n \"PROC_SEQ\": \"2\",\n \"CMWO\": \"0\",\n \"PFNARADIO\": \"\",\n \"WPCOMMENTS\": \"\",\n \"SCHADASSID\": \"\"\n }\n ],\n \"ASSIGNMENT\": {\n \"data\": [\n {\n \"CONTACTID\": \"BWDEMO\",\n \"DATE_SCH\": \"2017-12-10T00:00:00.000Z\",\n \"STATUS\": \"ASSIGNED\",\n \"CUID\": \"_52404S6OA\",\n \"EST_HOURS\": \"0.00\",\n \"SCHADASSID\": \"\",\n \"SIGNEDON\": \"\"\n }\n ]\n },\n \"DOCUMENTS\": {\n \"data\": []\n }\n }\n }\n }\n}"},{"id":"733d8aba-d1af-4ce7-a365-664013be9617","name":"Unable to complete the operation","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"POSTMAN","type":"text"}],"url":{"raw":"https://x46.emaint.com/api/v2/getObjectData?table=WORK&keyvalue=120&objectid=WO_WO","host":["https://x46.emaint.com/api/v2"],"path":["getObjectData"],"query":[{"key":"table","value":"WORK"},{"key":"keyvalue","value":"120"},{"key":"objectid","value":"WO_WO"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"Record not found.\"\n}"},{"id":"37971062-6e87-4211-9b06-2638765103d1","name":"Authentication failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{vault:x4-api-token}}","description":"Added as a part of security scheme: bearer"},{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"POSTMAN","type":"text"}],"url":{"raw":"https://x46.emaint.com/api/v2/getObjectData?table=WORK&keyvalue=120&objectid=WO_WO","host":["https://x46.emaint.com/api/v2"],"path":["getObjectData"],"query":[{"key":"table","value":"WORK"},{"key":"keyvalue","value":"120"},{"key":"objectid","value":"WO_WO"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"Authentication failure\"\n}"}],"_postman_id":"da28ccdb-2e2b-454e-a15a-9931937df368"}],"id":"933f1c7a-3aa2-429d-b6b3-9c4bbdcd7d5b","description":"

Pulls records in batch by given criteria

\n","_postman_id":"933f1c7a-3aa2-429d-b6b3-9c4bbdcd7d5b","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"General Operations - One record","item":[{"name":"Add record","id":"1a26b20c-6fb7-41d2-9bae-a764257d7017","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"body":{"mode":"raw","raw":"{\n \"table\": \"WORK\",\n \"payload\": {\n \"wo\": \"[AUTO]\",\n \"brief_desc\": \"Test brief description\",\n \"assignid\": \"Test Assign ID\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/record","description":"

Adds a new table record with the data provided in “payload” json object

updates existing record with the data provided in “payload” json object

deletes or restores existing table record. Use property “action”:“delete” to delete the record and “action”:“restore” to restore a deleted record

Standard methods to create, update or delete a record from the account’s database

Note that some operations require calling specific API end-points. For the following actions it is not recommended to use /Record API:

sign on/off - use /signOn and /signOff
close out work order - use /closeWorkOrder
document upload - use /uploadDocument
approve/reject work order request - use /approveRequest and /rejectRequest
adjust inventory on-hand - use /adjustInventory
receive PO items - use /savePoReceipt

\n","_postman_id":"5b7a40b6-7dcd-4e48-806a-68917d6d233a","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"General Operations - Multiple records","item":[{"name":"Add one or more records in bulk","id":"b8a3880b-401f-4b4e-954d-aba65fd3291a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"body":{"mode":"raw","raw":"[\n {\n \"table\": \"WORK\",\n \"payload\": {\n \"wo\": \"[AUTO]\",\n \"brief_desc\": \"Test brief description\",\n \"assignid\": \"Test Assign ID\"\n }\n },\n {\n \"table\": \"WORK\",\n \"payload\": {\n \"wo\": \"[AUTO]\",\n \"brief_desc\": \"Another brief description\",\n \"assignid\": \"Another Assign ID\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/records","description":"

Adds multiple table record with the data provided in “payload” json object. Requires an array of records in JSON format in the payload and can have a mix with records belonging to different tables. The response contains an array to output the status of each record attempted to be added, updated or deleted

updates existing record with the data provided in “payload” json object

deletes or restores existing table record. Use property “action”:“delete” to delete the record and “action”:“restore” to restore a deleted record

Standard methods to create, update or delete multiple records in bulk

\n","_postman_id":"1ec4eb70-3819-45be-a2b0-9072135a6eb0","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"Work Orders Management","item":[{"name":"Sign On","id":"3204e0a5-0e9d-4701-a1ce-ff91f779f15e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"body":{"mode":"raw","raw":"{\n \"wo\": \"12345\",\n \"signonDate\": \"2022-01-07T10:30:00.000Z\",\n \"contactId\": \"ABCDEF99\"\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/signOn","description":"

Use this method to sign on to a work order.

Remarks:

contactId must be a valid contact Id. If you omit the parameter, the authenticated user executing the request is used.

Use this method to sign off a work order.

Remarks:

contactId must be a valid contact Id. If you omit the parameter, the authenticated user executing the request is used.
use completed:false to just pause working to the work order specified while still being signed on
completed is optional - default value is true
signoffDate is optional - default value is current date/time
User must be signed on already.

Use this method to sign on to a work order.

Remarks:

date_cmpl is optional.

Work orders sign on / sign off management

\n","_postman_id":"e5e35e9c-eb72-4959-ae11-31fba8b7a45d","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"Work Order Requests Management","item":[{"name":"Approve Work Request","id":"57e5a396-4948-477c-86d3-0b58289cf6ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"body":{"mode":"raw","raw":"{\n \"requestno\": \"WORK\",\n \"contactId\": \"BWDEMO\"\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/approveRequest","description":"

Use this method to approve an open work order request

Use this method to reject an open work order request

Manage work order request status

\n","_postman_id":"8c83756a-720f-4aea-9e32-8053d52233d9","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"Inventory Management","item":[{"name":"Adjust Inventory Item Quantities","id":"292be4b0-8503-443f-ba61-68f35864d940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"body":{"mode":"raw","raw":"{\n \"type\": \"ADJUSTMENT\",\n \"payload\": {\n \"item\": \"2004\",\n \"document\": \"PHYSCOUNT\",\n \"invloc\": \"MAIN\",\n \"qtyadj\": 10\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/adjustInventory","description":"

Use this method to set or adjust on-hand quantities of an existing inventory item

Inventory items management

\n","_postman_id":"d1f962ef-6599-445e-b0c7-90b7a2cdf4dc","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"Purchase Orders","item":[{"name":"Receive PO Items","id":"d35d5de7-361d-4a1d-9a0e-afacf23d77ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"body":{"mode":"raw","raw":"{\n \"purno\": \"00027\",\n \"type\": \"TOTALREC\",\n \"payload\": [\n {\n \"item\": \"2003\",\n \"qty\": 1\n },\n {\n \"lineid\": \"_61411G2ER\",\n \"qty\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://x46.emaint.com/api/v2/savePoReceipt","description":"

Use this method to receive items in existing Purchase Order (PO)

Purchase orders management

\n","_postman_id":"1530e0cb-4a22-418e-82f9-d6be7ddb63a8","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"Documents Management","item":[{"name":"Download document","id":"0e90fe1c-edc5-4120-9435-5b893a9c3518","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"url":"https://x46.emaint.com/api/v2/downloadDocument?id={{DOCUMENT_ID}}","description":"

Use this method to download existing document or an image file already stored in Document Storage

(Required) Document identifier

\n","type":"text/plain"},"key":"id","value":"{{DOCUMENT_ID}}"}],"variable":[]}},"response":[{"id":"edfa0af7-96af-4f6a-a93c-9344cce5924c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://x46.emaint.com/api/v2/downloadDocument?id=elit f","host":["https://x46.emaint.com/api/v2"],"path":["downloadDocument"],"query":[{"key":"id","value":"elit f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"image/jpeg"}],"cookie":[],"responseTime":null,"body":"elit f"},{"id":"8884a0b5-1398-405f-b0e9-2b874089533f","name":"File not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://x46.emaint.com/api/v2/downloadDocument?id=elit f","host":["https://x46.emaint.com/api/v2"],"path":["downloadDocument"],"query":[{"key":"id","value":"elit f"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"File not found\"\n}"},{"id":"2225325b-058c-4e7c-a7f6-abb562dde23f","name":"Authentication failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://x46.emaint.com/api/v2/downloadDocument?id=elit f","host":["https://x46.emaint.com/api/v2"],"path":["downloadDocument"],"query":[{"key":"id","value":"elit f"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"Authentication failure\"\n}"}],"_postman_id":"0e90fe1c-edc5-4120-9435-5b893a9c3518"},{"name":"Upload Document","id":"f347d4f5-6be9-47a5-8bad-0ffa4d0f74b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}","type":"text"}],"url":"https://x46.emaint.com/api/v2/uploadDocument","description":"

Description

Use this method to upload a new document or an image file directly in Document Storage.

Here are the applicable parameters:

filename - name of the file uploaded (including file extension)
description (optional)
folder - logical path to the file
data - base64 encoded string of the file contents

Remarks

if another file with same name and extension already exist in the destination folder the system will add a timestamp suffix to distinguish both files on the server
if the folder is blank or not specified system defaults to \"MOBILE\" folder
you may specify a folder path , i.e \"MOBILE/TEST/TEST2\"
in case the folder does not exist on server it is being created.

Working with documents

\n","_postman_id":"40a1f509-5f97-4212-a828-59060e4f2705","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"User","item":[{"name":"Get user permissions","id":"33a551e9-47cd-4617-91fe-2c75d04908d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"XT-UserAgent","value":"{{USER_AGENT}}"}],"url":"https://x46.emaint.com/api/v2/getPermissions?userId={{USER_ID}}","description":"

Use this method to obtain a list of permissions to which the requested user have access ritghts to.

(Required) User identifier

\n","type":"text/plain"},"key":"userId","value":"{{USER_ID}}"}],"variable":[]}},"response":[{"id":"969d900a-d3f0-4a80-8767-2397f30b60fb","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://x46.emaint.com/api/v2/getPermissions?userId=elit f","host":["https://x46.emaint.com/api/v2"],"path":["getPermissions"],"query":[{"key":"userId","value":"elit f"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": true,\n \"message\": \"\",\n \"type\": \"Administration User\",\n \"data\": [\n {\n \"item_desc\": \"Access File\",\n \"sec_desc\": \"ASSET TYPE\",\n \"sec_no\": \"T001\"\n }\n ]\n}"},{"id":"091d46aa-761e-4a4f-a3a2-202173f9a2cd","name":"User not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://x46.emaint.com/api/v2/getPermissions?userId=elit f","host":["https://x46.emaint.com/api/v2"],"path":["getPermissions"],"query":[{"key":"userId","value":"elit f"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"User not found\"\n}"},{"id":"061aa179-ca3c-43c4-841a-841663fe990b","name":"Authentication failure","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://x46.emaint.com/api/v2/getPermissions?userId=elit f","host":["https://x46.emaint.com/api/v2"],"path":["getPermissions"],"query":[{"key":"userId","value":"elit f"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": false,\n \"message\": \"Authentication failure\"\n}"}],"_postman_id":"33a551e9-47cd-4617-91fe-2c75d04908d8"}],"id":"6dd68cdc-50a5-420b-99b7-de87060e4d22","description":"

Manage users

\n","_postman_id":"6dd68cdc-50a5-420b-99b7-de87060e4d22","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}},{"name":"Version","item":[{"name":"Get API Version","id":"52df9f17-e791-45bb-81b1-9b0bbfda9cf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://x46.emaint.com/api/v2/version","urlObject":{"path":["version"],"host":["https://x46.emaint.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"ab5b41c7-a16d-4315-8802-a8f60516547e","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://x46.emaint.com/api/v2/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"valid\": true,\n \"message\": \"OK\",\n \"version\": \"2.0.0\"\n}"}],"_postman_id":"52df9f17-e791-45bb-81b1-9b0bbfda9cf7"}],"id":"77769315-f1b7-4822-b1cd-24db55a9148a","description":"

API version

\n","_postman_id":"77769315-f1b7-4822-b1cd-24db55a9148a","auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"},"isInherited":true,"source":{"_postman_id":"920169ff-5dd3-4a7f-8537-fff78cc25514","id":"920169ff-5dd3-4a7f-8537-fff78cc25514","name":"eMaint X4 API v2","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"token":"{{JWT-Token}}"}},"event":[{"listen":"prerequest","script":{"id":"796460dc-9a83-441a-afe9-374254162ed0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e3e9437-7e0a-4c1e-964e-4e4e347498db","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://x46.emaint.com/api/v2"},{"key":"password","value":"{{vault:x4-password}}"},{"key":"username","value":"BWDEMO"},{"key":"agent","value":"POSTMAN"},{"key":"token","value":"{{vault:x4-api-token}}"},{"key":"table_name","value":"WORK"},{"key":"table_id","value":"120"},{"key":"object_id","value":"WO_WO"},{"key":"ods","value":"{\"joinwith\":[{\"columns\":[{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"BUILDING\"},{\"name\":\"FLR_LEVEL\"},{\"name\":\"ROOM_SPCE\"}],\"dd_dbf\":\"COMPINFO\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"LAB\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"FULLNAME\"},{\"name\":\"EMAIL\"}],\"dd_dbf\":\"CONTACT\"}],\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"TRANDATE\"},{\"name\":\"LAB_START\"},{\"name\":\"COMMENT\"},{\"name\":\"LAB_STOP\"},{\"name\":\"QTY\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"LABTRANS\",\"dd_dbf\":\"CHARGES\"},{\"filter\":{\"field\":\"ctype\",\"value\":\"MAT\",\"operator\":\"eq\"},\"joinwith\":[{\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"DESCRIP\"}],\"dd_dbf\":\"ARINVT01\"},{\"columns\":[{\"name\":\"INV_NO\"},{\"name\":\"INVLOC\"}],\"dd_dbf\":\"ICJOURNL\"}],\"columns\":[{\"name\":\"ITEM\"},{\"name\":\"CATEGORY\"},{\"name\":\"TRANDATE\"},{\"name\":\"ADDUSER\"},{\"name\":\"INVLOC\"},{\"name\":\"UNITCOST\"},{\"name\":\"QTY\"},{\"name\":\"COMMENT\"},{\"name\":\"TRANID\"},{\"name\":\"SCHADASSID\"}],\"alias\":\"MATUSETRANS\",\"dd_dbf\":\"CHARGES\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"TASK_DESC\"},{\"name\":\"TASKTEXT\"},{\"name\":\"STATUS\"},{\"name\":\"COMPID\"},{\"name\":\"WO\"},{\"name\":\"TASK_NO\"},{\"name\":\"READING\"},{\"name\":\"PROC_SEQ\"},{\"name\":\"CMWO\"},{\"name\":\"PFNARADIO\"},{\"name\":\"SCHADASSID\"}],\"dd_dbf\":\"WO_PROCS\"},{\"columns\":[{\"name\":\"CONTACTID\"},{\"name\":\"DATE_SCH\"},{\"name\":\"STATUS\"},{\"name\":\"CUID\"},{\"name\":\"EST_HOURS\"},{\"name\":\"SCHADASSID\"},{\"name\":\"SIGNEDON\"}],\"alias\":\"ASSIGNMENT\",\"dd_dbf\":\"WOASSIGN\"},{\"columns\":[{\"name\":\"CUID\"},{\"name\":\"SCHADASSID\"},{\"name\":\"CDESC\"},{\"name\":\"MLINK\"}],\"alias\":\"DOCUMENTS\",\"dd_dbf\":\"WO_DOCS\"}],\"columns\":[{\"name\":\"WO\"},{\"name\":\"BRIEF_DESC\"},{\"name\":\"WORK_DESC\"},{\"name\":\"DATE_WO\"},{\"name\":\"TIME\"},{\"name\":\"WORKSTATUS\"},{\"name\":\"WO_TYPE\"},{\"name\":\"SCH_DATE\"},{\"name\":\"DATE_CMPL\"},{\"name\":\"PRIORITY\"},{\"name\":\"COMPID\"},{\"name\":\"COMP_DESC\"},{\"name\":\"DEPARTMENT\"},{\"name\":\"ADDUSER\"}]}"}]}