Page tree

 

This is the latest version of the APIs.

Contents:


Perform a dry-run of creating a release for the specified deployment, which performs a check of all permissions required to import the package, as well as any specified import rules.

If they occur, errors are reported in the response.

After you have successfully completed a dry-run, you can formally create the release via API. See API Releases Create v4.

NOTE: Releases pertain to Production instances of the Trifacta® platform. For more information, see Overview of Deployment Manager.

Version:  v4

Required Permissions

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: POST

Endpoint:

/v4/deployments/<id>/releases/dryRun

where:

ParameterDescription
<id>Internal identifier for the deployment

Request URI - Example:

/v4/deployments/2/releases/dryRun

Request Body:

The request body must include the following key and value combination submitted as form data:

keyvalue
data"@path-to-file"

Example request - curl:

curl -X POST \
  http://example.com:3005/v4/deployments/1/releases/dryRun \
  -H 'authorization: Basic c29sc29uQHRyaWZhY3RhLmNvbTphZG1pbg==' \
  -H 'cache-control: no-cache' \
  -H 'content-type: multipart/form-data' \
  -F data=@response.zip

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
  "importRuleChanges": {
    "object": [],
    "value": []
  },
  "deletedObjects": {},
  "primaryFlowIds": [
    8
  ],
  "flows": [
    {
      "id": 8,
      "name": "2013 POS",
      "description": null,
      "deleted_at": null,
      "cpProject": null,
      "workspaceId": 1,
      "createdAt": "2019-02-13T18:39:03.426Z",
      "updatedAt": "2019-02-13T20:52:03.707Z",
      "createdBy": 7,
      "updatedBy": 7,
      "folderId": null
    }
  ],
  "datasources": [
    {
      "isDynamicOrConverted": false,
      "id": 30,
      "dynamicPath": null,
      "cpProject": null,
      "workspaceId": 1,
      "connectionId": null,
      "deleted_at": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "storageLocationId": 13,
      "createdAt": "2019-02-13T18:39:03.569Z",
      "updatedAt": "2019-02-13T20:52:03.803Z",
      "createdBy": 7,
      "updatedBy": 7,
      "parsingScriptId": 40,
      "size_deprecated": null,
      "path_deprecated": null
    },
    {
      "isDynamicOrConverted": false,
      "id": 31,
      "dynamicPath": null,
      "cpProject": null,
      "workspaceId": 1,
      "connectionId": null,
      "deleted_at": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "storageLocationId": 14,
      "createdAt": "2019-02-13T18:39:03.876Z",
      "updatedAt": "2019-02-13T20:52:03.806Z",
      "createdBy": 7,
      "updatedBy": 7,
      "parsingScriptId": 41,
      "size_deprecated": null,
      "path_deprecated": null
    },
    {
      "isDynamicOrConverted": false,
      "id": 32,
      "dynamicPath": null,
      "cpProject": null,
      "workspaceId": 1,
      "connectionId": null,
      "deleted_at": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "storageLocationId": 15,
      "createdAt": "2019-02-13T18:39:04.232Z",
      "updatedAt": "2019-02-13T20:52:03.808Z",
      "createdBy": 7,
      "updatedBy": 7,
      "parsingScriptId": 42,
      "size_deprecated": null,
      "path_deprecated": null
    },
    {
      "isDynamicOrConverted": false,
      "id": 33,
      "dynamicPath": null,
      "cpProject": null,
      "workspaceId": 1,
      "connectionId": null,
      "deleted_at": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "storageLocationId": 16,
      "createdAt": "2019-02-13T18:39:04.546Z",
      "updatedAt": "2019-02-13T20:52:03.810Z",
      "createdBy": 7,
      "updatedBy": 7,
      "parsingScriptId": 43,
      "size_deprecated": null,
      "path_deprecated": null
    },
    {
      "isDynamicOrConverted": false,
      "id": 34,
      "dynamicPath": null,
      "cpProject": null,
      "workspaceId": 1,
      "connectionId": null,
      "deleted_at": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "storageLocationId": 17,
      "createdAt": "2019-02-13T18:39:04.884Z",
      "updatedAt": "2019-02-13T20:52:03.813Z",
      "createdBy": 7,
      "updatedBy": 7,
      "parsingScriptId": 44,
      "size_deprecated": null,
      "path_deprecated": null
    },
    {
      "isDynamicOrConverted": false,
      "id": 35,
      "dynamicPath": null,
      "cpProject": null,
      "workspaceId": 1,
      "connectionId": null,
      "deleted_at": null,
      "isSchematized": true,
      "isDynamic": false,
      "isConverted": false,
      "disableTypeInference": false,
      "hasStructuring": true,
      "storageLocationId": 18,
      "createdAt": "2019-02-13T18:39:05.237Z",
      "updatedAt": "2019-02-13T20:52:03.815Z",
      "createdBy": 7,
      "updatedBy": 7,
      "parsingScriptId": 45,
      "size_deprecated": null,
      "path_deprecated": null
    }
  ],
  "flownodes": [
    {
      "id": 39,
      "scriptId": 40,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": false,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:03.741Z",
      "updatedAt": "2019-02-13T20:52:03.917Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    },
    {
      "id": 40,
      "scriptId": 41,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": false,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:04.049Z",
      "updatedAt": "2019-02-13T20:52:03.927Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    },
    {
      "id": 41,
      "scriptId": 42,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": false,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:04.400Z",
      "updatedAt": "2019-02-13T20:52:03.936Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    },
    {
      "id": 42,
      "scriptId": 43,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": false,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:04.705Z",
      "updatedAt": "2019-02-13T20:52:03.944Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    },
    {
      "id": 43,
      "scriptId": 44,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": false,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:05.040Z",
      "updatedAt": "2019-02-13T20:52:03.956Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    },
    {
      "id": 44,
      "scriptId": 45,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": false,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:05.433Z",
      "updatedAt": "2019-02-13T20:52:03.965Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    },
    {
      "id": 45,
      "scriptId": 46,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": true,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:18.716Z",
      "updatedAt": "2019-02-13T20:52:03.972Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    },
    {
      "id": 46,
      "scriptId": 47,
      "flowId": 8,
      "flowNodeId": null,
      "deleted_at": null,
      "wrangled": true,
      "referenceId": null,
      "createdAt": "2019-02-13T18:39:32.754Z",
      "updatedAt": "2019-02-13T20:52:03.981Z",
      "createdBy": 7,
      "updatedBy": 7,
      "activesampleId": null
    }
  ],
  "outputobjects": [],
  "release": {
    "id": 3,
    "deploymentId": 1,
    "packageUuid": "9bae78c0-2fcb-11e9-9523-77f56ed58844",
    "notes": "example_flow",
    "active": true,
    "createdBy": 7,
    "updatedBy": 7,
    "updatedAt": "2019-02-13T20:52:03.696Z",
    "createdAt": "2019-02-13T20:52:03.696Z"
  }
}

Reference

For more information on import rule changes, see Define Import Mapping Rules.

 

This page has no comments.