Skip to content

Download Endpoints

The list of endpoints can be downloaded as a CSV file using the Management API. This is the same list found on the main QIE application menu under View -> View Endpoints. It can also be downloaded from within the QIE application using the Export button on the endpoints dialog. To download the CSV file with the Management API, call the URI http(s)://<qie_server>:<management_api_port>/engine/downloadEndpoints with the following payload:

{}

Base JSON Payload Definition

Node Description
None There is no required payload for the request call

The following response is received when the download was successful:

HTTP Status: 200

{
   "endpointsFile": "<base64 encoded endpoints CSV file>"
}
Node Description
endpointsFile Base64 encoded endpoints CSV file. This file contains the same content found on the main QIE application menu under View -> View Endpoints.

Note

The CSV covers only what the user the apiToken belongs to can reach, the same scope the View Endpoints dialog applies in the application. A zone that user can neither view nor manage errors for contributes no rows. The Schedule and Endpoint columns read Hidden where that user cannot both view the zone and manage or edit it. Use a token belonging to a System Administrator to export every zone.

The Schedule and Endpoint columns read Locked where the node, or the connection a database receiver or a database, web service or DICOM destination points at, sits in a locked package whose configuration is neither viewable nor editable. That value appears for every user, including a System Administrator, until that user unlocks the package. See View Endpoints for the full rules.

If there is an error exporting the config file, then the following response is received:

HTTP Status: 400

{
   "error": "<error message>"
}

Example curl command:

curl -H "apiToken:abc123" --request POST http://qieserver:9999/engine/downloadEndpoints -d '{}'

curl -H "apiToken:abc123" --request POST http://qieserver:9999/engine/downloadEndpoints -d "{}"

curl -H @{"apiToken"="abc123"} -Method POST http://qieserver:9999/engine/downloadEndpoints -Body '{}' | Select-Object -Expand RawContent

The received count for the source node and the completed counts for the destination nodes can be accessed with this API. When the date range spans more than one day the returned count is a sum for the range. When the date range contains today's date the response is the counts written to the database. The write frequency is determined by the Java option -Dqie.dailyMessageCountWriteFrequency (default=1500ms).