API Deployments Object Import Rules Patch v4

Create a list of object-based import rules for the specified deployment. Delete all previous rules applied to the same object.

The generated rules apply to all flows that are imported into the deployment after they has 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 value mappings. See API Deployments Value Import Rules Patch v4.

Version: v4

Required Permissions

Request

Request Type: PATCH

Endpoint:

/v4/deployments/<id>/objectImportRules

where:

Request URI - Example:

/v4/deployments/4/objectImportRules

Request Body Example: Replace connection

The following JSON array describes replacing the connection specified by the UUID, which is a field on the connection object exported from the original platform instance.  This connection reference is replaced by a reference to connection ID 1 in the local platform instance and is applied to any release uploaded into the deployment after the rule has been created:

[
  {
    "tableName": "connections",
    "onCondition": {
      "uuid": "d75255f0-a245-11e7-8618-adc1dbb4bed0"
    },
    "withCondition": {
      "id": 1
    }
  }
]

You can specify matching values using string literals. 

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

{"id":"22"}

For more information on patterns, see Text Matching.

Request Body Example: Replace multiple connections

This example request includes replacements for multiple connection references.

This type of replacement applies if the imported packages contain sources that are imported through two separate connections:

[
  {
    "tableName": "connections",
    "onCondition": {
      "uuid": "d75255f0-a245-11e7-8618-adc1dbb4bed0"
    },
    "withCondition": {
      "id": 1
    }
  },
  {
    "tableName": "connections",
    "onCondition": {
      "uuid": "d552045e0-c314-22b5-9410-acd1bcd8eea2"
    },
    "withCondition": {
      "id": 2
    }
  }
]

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 connection

If you submit the request again, the response contains the rule definition of the previous update, which has been deleted. This example applies to the one-rule change listed previously:

{    "deleted": {

        "data": [
            {
                "onCondition": {
                    "uuid": "d75255f0-a245-11e7-8618-adc1dbb4bed0"
                },
                "withCondition": {
                    "id": 1
                },
                "id": 1,
                "tableName": "connections",
                "createdAt": "2019-02-13T23:07:51.720Z",
                "updatedAt": "2019-02-13T23:07:51.720Z",
                "creator": {
                    "id": 7
                },
                "updater": {
                    "id": 7
                },
                "deployment": {
                    "id": 4
                }
            }
        ]
    }
}

Reference