API Reference

Refresh batch of connections

Description

Refreshes multiple connections within the same spreadsheet, based on ID.When connecting to multiple spreadsheets, tables or other destinations, use the singular refresh connection instead.
usePreviousDestinationParameters and usePreviousSourceParameters will use the exact parameters of your previous run; any new parameters you’ve provided will be ignored.

POST /api/v1/connections/batch/refresh

🚧

Required OAuth Scopes:

No OAuth scopes are required to use this endpoint.

Body parameter example

[
  {
    "connectionId": "string",
    "destinationParameters": {},
    "sourceParameters": {},
    "usePreviousDestinationParameters": false,
    "usePreviousSourceParameters": false,
    "workspaceId": "string"
  }
]

Code Samples

curl -X POST https://h.app.wdesk.com/s/wdata/prep/api/v1/connections/batch/refresh  \ 
-H 'Content-Type: application/json' \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http POST https://h.app.wdesk.com/s/wdata/prep/api/v1/connections/batch/refresh  \ 
Content-Type:application/json \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=POST "https://h.app.wdesk.com/s/wdata/prep/api/v1/connections/batch/refresh" \
 --output-document -  \ 
 --header 'Content-Type: application/json' \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://h.app.wdesk.com/s/wdata/prep/api/v1/connections/batch/refresh', headers = headers)

print(r.json())

Returns

200 - OK

undefined

Example Responses


{
  "body": {
    "batchRefreshId": "string",
    "childRefreshes": [
      {
        "connectionId": "string",
        "created": "string",
        "createdBy": "string",
        "destinationParameters": {},
        "destinationStatus": "string",
        "destinationWorkspaceId": "string",
        "error": "string",
        "jobId": "string",
        "sourceParameters": {},
        "sourceStatus": "string",
        "sourceWorkspaceId": "string",
        "updated": "string",
        "workspaceId": "string"
      }
    ],
    "created": "string",
    "createdBy": "string",
    "destinationStatus": "string",
    "error": "string",
    "sourceStatus": "string",
    "updated": "string"
  },
  "code": "integer"
}