Diagrams - Download (Asynchronous)

GET {{server_url}}/HOPEXGraphQL/api/async/diagram/{{diagramId}}/image

This endpoint allows to download a given diagram by its absolute identifier. 3 formats are avaiable : PNG, JPEG, SVG. The default format is PNG. This endpoint is synchronous : the diagram will be generared on demand and will return the image. In case the generation of the diagram is too long use the asynchronous endpoint.

3 parameters in the headers should be defined : * x-hopex-wait : time to wait for a result in the body response. If 0 we don't wait and get immediately a task ID * x-hopex-task : the ID of the tasks that is running to compute the result * x-hopex-session : the session ID where the task is being executed

** Operating mode : ** First call : Have in the header x-hopex-wait defined. If > 0 then we wait the defined time for a response The result of this call is : - either the response : status code 200 - either a task id and a session token : status code 206

Second call : Call the end point with in the header the x-hopex-task and the x-hopex-session. The result of this call is : - either the result response in the body : code 200 - either a response to mentionned the task is still in progress : code 206

HEADERS

KeyDatatypeRequiredDescription
x-hopex-environment-idstring
x-hopex-repository-idstringDefault value PNG. Possible choice : image/png, image/jpeg and image/svg+xml
x-hopex-profile-idstring
Acceptstring
x-hopex-jpegqualitynumber
x-hopex-waitnumber
x-hopex-taskstring
x-hopex-sessiontokenstring