API Deployments Value Import Rules Patch v4

Create a list of value-based import rules for the specified deployment. Delete any previous rules applied to the same values.

The generated rules apply to all flows that are imported into the Production instance after they have been created.

The response contains any previously created rules that have been deleted as a result of this change.

You can also make replacements in the import package based on object references. See API Deployments Object Import Rules Patch v4.

Version:  v4

Required Permissions

Request

Request Type: PATCH

Endpoint:

/v4/deployments/<id>/valueImportRules

where:

Request URI - Example:

/v4/deployments/4/valueImportRules

Request Body Example: Single value replacement

The following JSON array describes a single replacement rule for the S3 bucket name. In this case, the wrangle-dev bucket name has been replaced by the wrangle-prod bucket name, which means data is pulled in the Production deployment from the appropriate S3 bucket. 

[
  {
    "type": "s3Bucket",
    "on": "wrangle-dev",
    "with": "wrangle-prod"
  }
]

Request Body Example: Multiple value replacements

The following JSON array describes two replacements for the fileLocation values. In this case, rules are applied in succession. 

[
  {
    "type": "fileLocation",
    "on": "klamath",
    "with": "klondike"
  },
  {
    "type": "fileLocation",
    "on": "//dev//",
    "with": "/prod/"
  }
]

In the above:

• The first rule replaces the string klamath in the path to the source with the following value: klondike. 
• The second rule performs a regular expression match on the string /dev/. Since the match is described using the regular expression syntax, the backslashes must be escaped. The replacement value is the following literal: /prod/.

You can specify matching values using the following types of matches:

{"on":"d75255f0-a245-11e7-8618-adc1dbb4bed0"}

{"on":"/[0-9a-zA-z]{8}-a245-11e7-8618-adc1dbb4bed0/"}

For more information on patterns, see Text Matching.

Response

Response Status Code - Success:  200 - OK

The response body contains any previously created rules that have been deleted as a result of this update.

Response Body Example: All new rule, no deletions

If the update does not overwrite any previous rules, then no rules are deleted. So, the response looks like the following:

{
    "deleted": []
}

Response Body Example: Replace file location, delete previous rule

If you submit the request again, the response contains the rule definition of the previous update, which has been deleted. 

{
    "deleted": {
        "data": [
            {
                "id": 1,
                "type": "s3Bucket",
                "on": "wrangle-dev",
                "with": "wrangle-prod",
                "createdAt": "2019-02-13T23:27:13.351Z",
                "updatedAt": "2019-02-13T23:27:13.351Z",
                "creator": {
                    "id": 7
                },
                "updater": {
                    "id": 7
                },
                "deployment": {
                    "id": 2
                }
            }
        ]
    }
}

Reference