PUT
/
team
/
{team_id}
/
datasets
/
{dataset_id}
/
dataRequests
/
{id}
curl --request PUT \
  --url https://api.chartbrew.com/team/{team_id}/datasets/{dataset_id}/dataRequests/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123,
  "dataset_id": 123,
  "connection_id": 123,
  "method": "GET",
  "route": "<string>",
  "headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "body": "<string>",
  "useGlobalHeaders": true,
  "query": "<string>",
  "pagination": false,
  "items": "items",
  "itemsLimit": 0,
  "offset": "offset",
  "paginationField": "<string>",
  "template": "<string>",
  "conditions": [
    {
      "field": "<string>",
      "value": "<string>",
      "operator": "="
    }
  ],
  "configuration": {},
  "variables": {},
  "Connection": {
    "id": 123,
    "name": "<string>",
    "type": "<string>",
    "subType": "<string>",
    "host": "<string>"
  }
}'
{
  "id": 123,
  "dataset_id": 123,
  "connection_id": 123,
  "method": "GET",
  "route": "<string>",
  "headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "body": "<string>",
  "useGlobalHeaders": true,
  "query": "<string>",
  "pagination": false,
  "items": "items",
  "itemsLimit": 0,
  "offset": "offset",
  "paginationField": "<string>",
  "template": "<string>",
  "conditions": [
    {
      "field": "<string>",
      "value": "<string>",
      "operator": "="
    }
  ],
  "configuration": {},
  "variables": {},
  "Connection": {
    "id": 123,
    "name": "<string>",
    "type": "<string>",
    "subType": "<string>",
    "host": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
team_id
integer
required
​
dataset_id
integer
required
​
id
integer
required

Body

application/json
​
id
integer
​
dataset_id
integer

Reference to Dataset model

​
connection_id
integer

Reference to Connection model

​
method
enum<string>
Available options:
GET,
POST,
PUT,
DELETE,
PATCH
​
route
string

API endpoint path

​
headers
object[]
​
body
string

Request body in JSON string format

​
useGlobalHeaders
boolean
default:
true
​
query
string
​
pagination
boolean
default:
false
​
items
string
default:
items

Path to items array in response

​
itemsLimit
integer
default:
0

Maximum number of items to return

​
offset
string
default:
offset

Pagination offset field name

​
paginationField
string

Field used for pagination

​
template
string

Template type for request formatting

​
conditions
object[]
​
configuration
object

Additional configuration options

​
variables
object

Request variables

​
Connection
object

Response

200
application/json
Updated data request
​
id
integer
​
dataset_id
integer

Reference to Dataset model

​
connection_id
integer

Reference to Connection model

​
method
enum<string>
Available options:
GET,
POST,
PUT,
DELETE,
PATCH
​
route
string

API endpoint path

​
headers
object[]
​
body
string

Request body in JSON string format

​
useGlobalHeaders
boolean
default:
true
​
query
string
​
pagination
boolean
default:
false
​
items
string
default:
items

Path to items array in response

​
itemsLimit
integer
default:
0

Maximum number of items to return

​
offset
string
default:
offset

Pagination offset field name

​
paginationField
string

Field used for pagination

​
template
string

Template type for request formatting

​
conditions
object[]
​
configuration
object

Additional configuration options

​
variables
object

Request variables

​
Connection
object
Get Dataset Data RequestsRun a Data Request