1E Core APIs

Below is a list of all the APIs exposed by 1E Core, along with their details. For Consumer APIs, you must include the following two headers:

Header	Value
x-tachyon-consumer	1EServiceNowCore
content-type	application/json

Sl. No.	Functionality	API	Parameters	Return value	Functionality
1	fetchInstruction	/Consumer/InstructionDefinitions	application, userName, password	boolean (true for a success and false for a failure)	Pulls instruction definitions and their respective parameters from the 1E server. Inserts/updates this data to the appropriate ServiceNow tables.
2	executeInstruction	/Consumer/Instructions/Targeted	instructionDefinitionID, devices, parameterObj, taskId, userName, password, application	sys_id of triggered instruction record	Executes an instruction on the 1E server. The device parameters will fetch its value from 1E end-user device(s) in an array format. Creates an instruction record and inserts instruction execution ID and current status of instruction into it.
3	getStatus	/Consumer/Instructions/<instruction_execution_id>	triggeredInstruction, userName, password	int (current status of an instruction)	Hits 1E's status API to retrieve the current status of the instruction and updates the triggered instruction record with the current status.
4	testConnection	/Consumer/InstructionDefinitions/	userName, password	boolean (true for a success and false for a failure)	Hits a 1E API to test if we are able to establish a connection with 1E server.
5	getResponse	/Consumer/Responses/<instruction_execution_id>	triggeredInstructionID, userName, password, startRange batchSize	JSON object	Hits 1E's response API for received instruction execution ID.
6	cancelInstruction	/Consumer/Instructions/{instructionId}/cancel/{keepData}	triggeredInstruction, userName, password	Success/failure code	Cancels execution of a running instruction on device(s).
7	getInstructionStatistics	/consumer/InstructionStatistics/summary/<instruction_execution_id>	triggeredInstructionRecord, userName, password	Statistics object of a running instruction	Hits 1E's API to get current statistics of a running instruction.