Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

D toc

Performs an import of a flow package, which  also applies any specified import rules.

Version: v3

Required Permissions

D s api auth

Request

Request Type: POST

Endpoint:

Code Block
/v3/flows/package/


Request URI - Example:

Code Block
/v3/flows/package

Request Body:

The request body must include the following key and value combination submitted as form data. This path is the location of the ZIP package that you are importing.

keyvalue
data"@path-to-file"

Example request - curl:

Code Block
curl -X POST \
  http://example.com:3005/v3/flows/package \
  -H 'authorization: Basic c29sc29uQHRyaWZhY3RhLmNvbTphZG1pbg==' \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data' \
  -F data=@response.zip

Response

Response Status Code - Success: 201 - Created

Response Body Example:

Code Block
{
    "importRuleChanges": {
        "object": [],
        "value": []
    },
    "flowName": "[267f4340]  2013 POS"
}

Reference

None.