Import Workflow

Import a workflow archive file using either a file located on the server or passed as the request body.

POST https://instance.securid.com/aveksa/command.submit?cmd=importWorkflow

Request

Parameters

command	about
filename	The filename in the import directory on the G&L server. The import directory is specified on the web services configuration page. Alternatively, the data can be sent as part of the request body. This option is not recommended and file should be passed using the POST body
overwrite	true, false Indicates existing objects should be overwritten. (Default) false
format	properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc. json - Useful format for parsing into javascript or other languages. See www.json.org for details.

Headers

Authorization	Bearer token
Accept	application/json
Content-Type	application/json

Body

Workflow zip archive

Response

Parameters

type	Executed command name
status	success, failure
message	Optional message to return along with the status

Examples

Request

Curl

curl -X GET "https://instance.securid.com/aveksa/command.submit" \
-d "cmd=importWorkflow" \
-d "format=json" \
-d "overwrite=true" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
--data '@/C:/Data/Workflow-04-26-2024.zip'

Python

Node.js

Response

200

{
    "data": {
        "type": "importWorkflow",
        "status": "success",
        "message": "Import started Fri Apr 26 18:19:37 UTC 2024...... <TRUNCATED>"
    }
}

200 Missing/Invalid Parameters

{
    "data": {
        "type": "importWorkflow",
        "status": "failure",
        "message": "The workflow import using the archive file /tmp/wfarchive4686824953448986718.tmp failed"
    }
}