DataExport
Entity - Data Export - Exports information from the system
Note for API version 8.0
As of API version 8.0, the visibility of the instruction responses is restricted in accordance to the Management Groups assigned to the users. See the note at the top of the Responses page for an explanation of how this works. The same principle applies to the DataExport APIs that export responses, where it is not possible to export any responses that cannot be accessed from the Responses API.
Verb | Request | Notes | Permissions required |
|---|---|---|---|
POST | /Consumer/DataExport | This endpoint can be used to convert any data formatted as a JSON array into a CSV. This endpoint provides a service and does NOT expose any internal data of the Tachyon system
| Usable by users that have any permissions on any of the product packs.
Returns Unauthorized (401) if user does not have the required permissions. |
POST | /Consumer/DataExport/ExportResponses | Exports responses for a specified question. Send JSON as body of the message with following fields:
| Any permission on the instruction whose responses are to be exported. |
POST | /Consumer/DataExport/ExportOtherResponses | Minimum API version 3.2 Exports other responses for a specified question. Send JSON as body of the message with following fields:
| Any permission on the instruction whose responses are to be exported. |
GET | /Consumer/DataExport/Type/{objectType} | UNAVAILABLE FROM 2.1 (INC) ONWARDS This endpoint can be used to retrieve objects of specific type from the Tachyon system. Supported object type values at the time of writing are: "devices", "instructiondefinitions", "questiondefinitions", "actiondefinitions" and "instructions" | Only "Global Administrators" role. Returns Unauthorized (401) if user does not have the required permissions. |
GET | /Consumer/DataExport /Responses/{instructionId:int}/aggregate/{flag:bool} | UNAVAILABLE FROM 2.1 (INC) ONWARDS This endpoint can be used to retrieve successful responses to a specific instruction.
NOTE - True will only work for questions that you can aggregate on the way out (so the ones with "Keep results") and only those will return a value here. Others will simply return an empty file. | Usable by users who have view permission to given instruction (same as Instructions endpoints)
Instruction's owner can also view responses. Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack or is not the owner. |
GET | /Consumer/DataExport /ResponsErrors/{instructionId:int}/aggregate/{flag:bool} | UNAVAILABLE FROM 2.1 (INC) ONWARDS This endpoint can be used to errors (or other results) to a specific instruction.
| Usable by users who have view permission to given instruction (same as Instructions endpoints)
Instruction's owner can also view responses. Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack or is not the owner. |