move_jobs
Creates, updates, deletes, gets or lists a move_jobs resource.
Overview
| Name | move_jobs |
| Type | Resource |
| Id | fivetran.connections.move_jobs |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier of the move job. Use this value to check the status of the move operation. (example: 01234567-89ab-cdef-0123-456789abcdef) |
connection_id | string | The unique identifier of the connection that was moved. (example: connection_id) |
destination_group_id | string | The unique identifier of the destination group to move the connection to. Retrieve group IDs from the [List All Groups](https://fivetran.com/docs/rest-api/api-reference/groups/list-all-groups) endpoint. (example: destination_group_id) |
source_group_id | string | The unique identifier of the destination group the connection was moved from. (example: source_group_id) |
completed_at | string (date-time) | The timestamp of when the move job completed (successfully or with failure). Null if the job has not completed yet. (example: 2024-01-01T00:05:00Z) |
created_at | string (date-time) | The timestamp of when the move job was created. (example: 2024-01-01T00:00:00Z) |
error_message | string | The error message if the move job failed. Null if the job has not failed. (example: Error details if the job failed) |
started_at | string (date-time) | The timestamp of when the move job started processing. Null if the job has not started yet. (example: 2024-01-01T00:00:30Z) |
status | string | The current status of the move job. Possible values: PENDING, IN_PROGRESS, SUCCESS, FAILED. (PENDING, IN_PROGRESS, SUCCESS, FAILED) (example: IN_PROGRESS) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | connection_id, job_id | Retrieves the status of an asynchronous connection move job. Use this endpoint to monitor the progress of a connection move operation that was initiated with the CONTINUE_WITH_DATA sync behavior. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
connection_id | string | The unique identifier of the connection. Retrieve it from the id field in the [List All Connections](https://fivetran.com/docs/rest-api/api-reference/connections/list-connections) response, or from the id field returned when you [Create a Connection](https://fivetran.com/docs/rest-api/api-reference/connections/create-connection). |
job_id | string | The unique identifier of the move job. This is returned in the response when you initiate a connection move. |
SELECT examples
- get
Retrieves the status of an asynchronous connection move job. Use this endpoint to monitor the progress of a connection move operation that was initiated with the CONTINUE_WITH_DATA sync behavior.
SELECT
id,
connection_id,
destination_group_id,
source_group_id,
completed_at,
created_at,
error_message,
started_at,
status
FROM fivetran.connections.move_jobs
WHERE connection_id = '{{ connection_id }}' -- required
AND job_id = '{{ job_id }}' -- required
;