Connectors: Push Data
Pushes data to be saved for and processed by a specified Connector. A run will be initiated with the data provided.
path Parameters
| accountId required | string |
| connectorId required | string ID of the Connector. |
query Parameters
| v required | string A date in |
| runMode | string Default: "DEFAULT" Enum: "DEFAULT" "COMPREHENSIVE" "DELETION" The run mode of the Connector. |
| dryRun | boolean Default: "false" Whether the run should include a dry run. |
Request Body schema: text/plain
The data to be saved for and processed by the Connector.
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string",
- "runUid": 0
}
}Connectors: Trigger
Triggers a run of the specified Connector.
path Parameters
| accountId required | string |
| connectorId required | string ID of the Connector. |
query Parameters
| v required | string A date in |
| runMode | string Default: "DEFAULT" Enum: "DEFAULT" "COMPREHENSIVE" "DELETION" The run mode of the Connector. |
| dryRun | boolean Default: "false" Whether the run should include a dry run. |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string",
- "connectorId": "string",
- "runUid": 0
}
}Connectors: Get Run
Retrieve information for a Run with a given ID and Connector ID.
path Parameters
| accountId required | string |
| connectorId required | string ID of the Connector. |
| runUid required | string UID of the Run. |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "runUid": 0,
- "status": "CREATED",
- "runMode": "DEFAULT",
- "triggerType": "AUTO",
- "createdTimestamp": 0,
- "completedTimestamp": 0,
- "createdCount": 0,
- "updatedCount": 0,
- "deletedCount": 0,
- "failedCount": 0,
- "unchangedCount": 0,
- "results": {
- "createdCount": 0,
- "updatedCount": 0,
- "deletedCount": 0,
- "failedCount": 0,
- "unchangedCount": 0
}, - "dryRunResults": {
- "createdCount": 0,
- "updatedCount": 0,
- "deletedCount": 0,
- "failedCount": 0,
- "unchangedCount": 0
}
}
}Connectors: Approve Run
Approves a dry run that is ready for review. The changes from the dry run will be applied once the run is approved.
path Parameters
| accountId required | string |
| connectorId required | string ID of the Connector. |
| runUid | string UID of the run to be approved. |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "connectorId": "string",
- "runUid": 0
}
}Connectors: Cancel Run
Cancels a non-terminal run.
path Parameters
| accountId required | string |
| connectorId required | string ID of the Connector. |
| runUid | string UID of the run to be cancelled. |
query Parameters
| v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "connectorId": "string",
- "runUid": 0
}
}