ReferenceFlows API

Tables

Simple data tables flows can read and write.

Method	Path	Summary
GET	`/api/tables`	List tables
POST	`/api/tables`	Create a table
GET	`/api/tables/:id`	Get a table and its rows
PUT	`/api/tables/:id`	Update a table's columns
DELETE	`/api/tables/:id`	Delete a table
POST	`/api/tables/:id/rows`	Add a row
PUT	`/api/tables/:id/rows/:rowId`	Update a row
DELETE	`/api/tables/:id/rows/:rowId`	Delete a row
DELETE	`/api/tables/:id/rows`	Delete every row

#List tables

GET/api/tables

Address: https://<your-org>.brambleit.cloud/flows/api/tables
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Query parameters

Name	Type	Description
`flow`	number

Response 200

Field	Type	Description
`tables`	array of object
`tables[].can_edit`	boolean

Example response

JSON

{
  "tables": [
    {
      "…tables.summary(t)": "…",
      "can_edit": true
    }
  ]
}

Errors

Status	Message
404	Flow not found

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Create a table

POST/api/tables

Address: https://<your-org>.brambleit.cloud/flows/api/tables
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Request body JSON

Name	Type	Description
`name`	string
`scope`	any
`columns`	array of any

Response 201

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","scope":"…","columns":[]}),
});
const data = await res.json();

#Get a table and its rows

GET/api/tables/:id

Address: https://<your-org>.brambleit.cloud/flows/api/tables/:id
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer

Query parameters

Name	Type	Description
`offset`	integer
`limit`	integer
`q`	any

Response 200

Field	Type	Description
`can_edit`	boolean

Example response

JSON

{
  "…tables.summary(t)": "…",
  "can_edit": true,
  "…page": "…"
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables/42', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();

#Update a table's columns

PUT/api/tables/:id

Address: https://<your-org>.brambleit.cloud/flows/api/tables/:id
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`name`	string
`columns`	array of any

Response 200

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables/42', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","columns":[]}),
});
const data = await res.json();

#Delete a table

DELETE/api/tables/:id

Address: https://<your-org>.brambleit.cloud/flows/api/tables/:id
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Add a row

POST/api/tables/:id/rows

Address: https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`data`	any

Response 201

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables/42/rows', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"data":"…"}),
});
const data = await res.json();

#Update a row

PUT/api/tables/:id/rows/:rowId

Address: https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows/:rowId
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer
`rowId`required	integer

Request body JSON

Name	Type	Description
`data`	any

Response 200

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables/42/rows/1', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"data":"…"}),
});
const data = await res.json();

#Delete a row

DELETE/api/tables/:id/rows/:rowId

Address: https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows/:rowId
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer
`rowId`required	integer

Response 200

Field	Type	Description
`ok`	boolean

Example response

JSON

{
  "ok": true
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables/42/rows/1', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Delete every row

DELETE/api/tables/:id/rows

Address: https://<your-org>.brambleit.cloud/flows/api/tables/:id/rows
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: Flows.

Path parameters

Name	Type	Description
`id`required	integer

Response 200

Field	Type	Description
`deleted`	any

Example response

JSON

{
  "deleted": null
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/flows/api/tables/42/rows', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

Was this page helpful?