ReferenceAtlas API

Admin

Asset types and their fields, Atlas settings and storage. Needs Global Administrator or Atlas Admin.

Method	Path	Summary
GET	`/api/admin/overview`	Atlas admin overview
POST	`/api/admin/types`	Create an asset type
PUT	`/api/admin/types/:id`	Update an asset type
PUT	`/api/admin/settings`	Update Atlas settings
GET	`/api/admin/storage`	What Atlas keeps in BRM-Blob: Blob's own figures for app "atlas" (used, any Atlas limit, the tenant pool) plus a breakdown from the files table by kind and o…
POST	`/api/admin/storage/free`	Deletes the files counted in "spare": attachments of records deleted more than 30 days ago, and document images that were never saved into a document

#Atlas admin overview

GET/api/admin/overview

Address: https://<your-org>.brambleit.cloud/atlas/api/admin/overview
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role).

Response 200

Field	Type	Description
`types`	array of object
`types[].assets`	integer
`field_types`	array of any
`ref_kinds`	array of any
`settings`	object
`settings.warn_days`	any
`counts`	object
`counts.licensed_users`	integer
`admins`	array of any

Example response

JSON

{
  "types": [
    {
      "…x": "…",
      "assets": 1
    }
  ],
  "field_types": [],
  "ref_kinds": [],
  "settings": {
    "warn_days": null
  },
  "counts": {
    "licensed_users": 1
  },
  "admins": []
}

Example request

JavaScript

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

#Create an asset type

POST/api/admin/types

Address: https://<your-org>.brambleit.cloud/atlas/api/admin/types
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role).

Request body JSON

Name	Type	Description
`name`	string	The type's name.
`category`	string	Where it's grouped.
`icon`	any
`colour`	any
`description`	string
`fields`	array of any	The type's fields (name, kind, required, secret…).
`sort`	number

Response 200

Field	Type	Description
`type`	string

Example response

JSON

{
  "type": "string"
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/admin/types', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","category":"string","icon":"…","colour":"…","description":"string","fields":[],"sort":12.5}),
});
const data = await res.json();

#Update an asset type

PUT/api/admin/types/:id

Address: https://<your-org>.brambleit.cloud/atlas/api/admin/types/:id
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role).

Path parameters

Name	Type	Description
`id`required	integer

Request body JSON

Name	Type	Description
`fields`	array of any
`archived`	any

Response 200

Field	Type	Description
`type`	string

Example response

JSON

{
  "type": "string"
}

Errors

Status	Message
404	Type not found

Example request

JavaScript

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

#Update Atlas settings

PUT/api/admin/settings

Address: https://<your-org>.brambleit.cloud/atlas/api/admin/settings
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role).

Request body JSON

Name	Type	Description
`warn_days`	number	Days before an expiry to warn.

Response 200

Field	Type	Description
`settings`	object
`settings.warn_days`	integer

Example response

JSON

{
  "settings": {
    "warn_days": 1
  }
}

Example request

JavaScript

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/atlas/api/admin/settings', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"warn_days":12.5}),
});
const data = await res.json();

#What Atlas keeps in BRM-Blob: Blob's own figures for app "atlas" (used, any Atlas limit, the tenant pool) plus a breakdown from the files table by kind and o…

GET/api/admin/storage

What Atlas keeps in BRM-Blob: Blob's own figures for app "atlas" (used, any Atlas limit, the tenant pool) plus a breakdown from the files table by kind and organisation, the largest files, and what can be freed.

Address: https://<your-org>.brambleit.cloud/atlas/api/admin/storage
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role).

Response 200

Field	Type	Description
`usage`	any
`kinds`	array of any
`orgs`	array of object
`orgs[].name`	string, or null
`largest`	array of object
`largest[].size`	number
`largest[].org_name`	any, or null
`spare`	any

Example response

JSON

{
  "usage": null,
  "kinds": [],
  "orgs": [
    {
      "…num(r)": "…",
      "name": "Example name"
    }
  ],
  "largest": [
    {
      "…r": "…",
      "size": 12.5,
      "org_name": null
    }
  ],
  "spare": null
}

Example request

JavaScript

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

#Deletes the files counted in "spare": attachments of records deleted more than 30 days ago, and document images that were never saved into a document

POST/api/admin/storage/free

Address: https://<your-org>.brambleit.cloud/atlas/api/admin/storage/free
Requires: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in). Admins only (Global Administrator or the app's admin role).

Response 200

Example request

JavaScript

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

Was this page helpful?