Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0681

D s api version

D toc

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

Version: v4

Required Permissions

D s api auth

Request

Request Type: POST

Endpoint:

Code Block
/v4/flows/package/


Request URI - Example:

Code Block
/v4/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/v4/flows/package \
  -H 'authorization: Basic YWRtaW5AdHJpZmFjdGEubG9jYWw6YWRtaW4=' \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data' \
  -F 'data=@path/to/flow.zip'

Response

Response Status Code - Success:  201 - Created

Response Body Example:

Code Block
{
  "importRuleChanges": {
    "object": [],
    "value": []
  },
  "deletedObjects": {},
  "primaryFlowIds": [
    7
  ],
  "flows": [
    {
      "id": 7,
      "name": "[6820bb80] 2013 POS",
      "description": null,
      "folderId": null,
      "createdBy": 1,
      "updatedBy": 1,
      "workspaceId": 1,
      "updatedAt": "2019-11-08T19:17:20.548Z",
      "createdAt": "2019-11-08T19:17:20.548Z",
      "deleted_at": null,
      "cpProject": null
    }
  ],
  "flownodes": [
    {
      "id": 11,
      "wrangled": false,
      "updatedAt": "2019-11-08T19:17:20.571Z",
      "createdAt": "2019-11-08T19:17:20.571Z",
      "referenceInfo": null,
      "activeSample": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "recipe": {
        "id": 9
      },
      "referencedFlowNode": null,
      "flow": {
        "id": 7
      }
    },
    {
      "id": 12,
      "wrangled": false,
      "updatedAt": "2019-11-08T19:17:20.571Z",
      "createdAt": "2019-11-08T19:17:20.571Z",
      "referenceInfo": null,
      "activeSample": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "recipe": {
        "id": 10
      },
      "referencedFlowNode": null,
      "flow": {
        "id": 7
      }
    },
    {
      "id": 13,
      "wrangled": false,
      "updatedAt": "2019-11-08T19:17:20.571Z",
      "createdAt": "2019-11-08T19:17:20.571Z",
      "referenceInfo": null,
      "activeSample": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "recipe": {
        "id": 11
      },
      "referencedFlowNode": null,
      "flow": {
        "id": 7
      }
    },
    {
      "id": 14,
      "wrangled": false,
      "updatedAt": "2019-11-08T19:17:20.571Z",
      "createdAt": "2019-11-08T19:17:20.571Z",
      "referenceInfo": null,
      "activeSample": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "recipe": {
        "id": 12
      },
      "referencedFlowNode": null,
      "flow": {
        "id": 7
      }
    },
    {
      "id": 15,
      "wrangled": false,
      "updatedAt": "2019-11-08T19:17:20.571Z",
      "createdAt": "2019-11-08T19:17:20.571Z",
      "referenceInfo": null,
      "activeSample": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "recipe": {
        "id": 13
      },
      "referencedFlowNode": null,
      "flow": {
        "id": 7
      }
    },
    {
      "id": 16,
      "wrangled": false,
      "updatedAt": "2019-11-08T19:17:20.571Z",
      "createdAt": "2019-11-08T19:17:20.571Z",
      "referenceInfo": null,
      "activeSample": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "recipe": {
        "id": 14
      },
      "referencedFlowNode": null,
      "flow": {
        "id": 7
      }
    },
    {
      "id": 17,
      "wrangled": true,
      "updatedAt": "2019-11-08T19:17:20.571Z",
      "createdAt": "2019-11-08T19:17:20.571Z",
      "referenceInfo": null,
      "activeSample": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "recipe": {
        "id": 15
      },
      "referencedFlowNode": null,
      "flow": {
        "id": 7
      }
    }
  ],
  "outputobjects": [
    {
      "id": 4,
      "execution": "photon",
      "profiler": true,
      "isAdhoc": true,
      "updatedAt": "2019-11-08T19:17:20.622Z",
      "createdAt": "2019-11-08T19:17:20.622Z",
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "flowNode": {
        "id": 17
      }
    }
  ],
  "datasources": [
    {
      "isDynamicOrConverted": false,
      "isIngested": false,
      "id": 5,
      "dynamicPath": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "updatedAt": "2019-11-08T19:17:20.540Z",
      "createdAt": "2019-11-08T19:17:20.411Z",
      "size_deprecated": null,
      "path_deprecated": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "workspace": {
        "id": 1
      },
      "parsingRecipe": {
        "id": 10
      },
      "storageLocation": {
        "id": 13
      },
      "connection": null
    },
    {
      "isDynamicOrConverted": false,
      "isIngested": false,
      "id": 6,
      "dynamicPath": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "updatedAt": "2019-11-08T19:17:20.540Z",
      "createdAt": "2019-11-08T19:17:20.414Z",
      "size_deprecated": null,
      "path_deprecated": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "workspace": {
        "id": 1
      },
      "parsingRecipe": {
        "id": 11
      },
      "storageLocation": {
        "id": 14
      },
      "connection": null
    },
    {
      "isDynamicOrConverted": false,
      "isIngested": false,
      "id": 7,
      "dynamicPath": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "updatedAt": "2019-11-08T19:17:20.540Z",
      "createdAt": "2019-11-08T19:17:20.415Z",
      "size_deprecated": null,
      "path_deprecated": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "workspace": {
        "id": 1
      },
      "parsingRecipe": {
        "id": 14
      },
      "storageLocation": {
        "id": 15
      },
      "connection": null
    },
    {
      "isDynamicOrConverted": false,
      "isIngested": false,
      "id": 8,
      "dynamicPath": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "updatedAt": "2019-11-08T19:17:20.540Z",
      "createdAt": "2019-11-08T19:17:20.417Z",
      "size_deprecated": null,
      "path_deprecated": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "workspace": {
        "id": 1
      },
      "parsingRecipe": {
        "id": 9
      },
      "storageLocation": {
        "id": 16
      },
      "connection": null
    },
    {
      "isDynamicOrConverted": false,
      "isIngested": false,
      "id": 9,
      "dynamicPath": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "updatedAt": "2019-11-08T19:17:20.540Z",
      "createdAt": "2019-11-08T19:17:20.419Z",
      "size_deprecated": null,
      "path_deprecated": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "workspace": {
        "id": 1
      },
      "parsingRecipe": {
        "id": 13
      },
      "storageLocation": {
        "id": 17
      },
      "connection": null
    },
    {
      "isDynamicOrConverted": false,
      "isIngested": false,
      "id": 10,
      "dynamicPath": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "updatedAt": "2019-11-08T19:17:20.540Z",
      "createdAt": "2019-11-08T19:17:20.421Z",
      "size_deprecated": null,
      "path_deprecated": null,
      "creator": {
        "id": 1
      },
      "updater": {
        "id": 1
      },
      "workspace": {
        "id": 1
      },
      "parsingRecipe": {
        "id": 12
      },
      "storageLocation": {
        "id": 18
      },
      "connection": null
    }
  ],
  "webhookflowtasks": []
}

Reference

NodeDescription
flowsInternal identifier of the flow and related data
flowNodesObjects (imported datasets, recipes, and reference objects) within the flow definition
outputobjects

Output objects for the flow. See API OutputObjects Get v4.

datasourcesSources of data for the flow.
webhookflowtasksIf webhook tasks have been defined for the flow, they are included in the import. For more information, see Create Flow Webhook Task.