Get the registry document

GET

/orgs/{org}/config/registry

curl --request GET \
  --url 'https://api.sloose.com/orgs/org_9f3c/config/registry?connector=con_8f2a' \
  --header 'Authorization: Bearer <token>'

• Production

The RegistryDoc as it currently stands — the modules, their keys and singular names, and their match defaults.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

The organisation id the session was issued for. A token for one organisation can never read another.

string

Example

org_9f3c

The organisation id the session was issued for. A token for one organisation can never read another.

Query Parameters

connector

The connection this is about, by id: one of the organisation’s, or your own. REQUIRED: absent or empty is 400 CONNECTION_REQUIRED, listing the connections this bearer may name, because nothing picks one for a request that does not say (design §14.8). Any other — another organisation’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

string

Example

con_8f2a

The connection this is about, by id: one of the organisation’s, or your own. REQUIRED: absent or empty is 400 CONNECTION_REQUIRED, listing the connections this bearer may name, because nothing picks one for a request that does not say (design §14.8). Any other — another organisation’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

Responses

200

The registry document.

Media typeapplication/json

object

version

integer

modules

required

Array<object>

object

seedMappings

seedMappings is no longer a module setting: a mapping a new import starts from belongs to the field it is about. Set defaultMapping on the field annotation — PATCH /orgs/{org}/config/fields/{module}/{apiName}, or fields/<module>.json in a configuration repository. Values already stored were moved by migration 0035.

key

required

string

/^[a-z][a-z0-9_]*$/

apiName

required

string

>= 1 characters

label

required

string

>= 1 characters

singular

required

string

/^[A-Za-z_$][\w$]*$/

singularLabel

One record as the CRM names it in words (“Sales Order”), which sentences say; singular is the identifier expressions use (“SalesOrder”). Read-only: discovery takes it from the CRM, so a pushed value is ignored. Absent until a discovery has read it, when a reader says singular.

string

color

string

defaultEnabled

boolean

uniqueFields

Array<string>

defaultDuplicateCheck

object

searchField

string

searchMethod

string

expression

string

excludedFields

Array<string>

child

object

of

required

string

/^[a-z][a-z0-9_]*$/

via

required

string

>= 1 characters

parentNeedsRows

boolean

pointer

string

>= 1 characters

maxRows

Any of:

integer

integer

> 0

string

string

Allowed values: off

layouts

object

key

additional properties

object

name

required

string

maxRows

Any of:

integer

integer

> 0

string

string

Allowed values: off

required

required

Array<string>

defaultLayout

string

>= 1 characters

stockEffect

object

field

required

string

>= 1 characters

label

required

string

>= 1 characters

direction

required

string

Allowed values: up down

expressionContext

string

/^[A-Za-z_$][\w$]*$/

apiDelayMs

integer

<= 60000

systemExcludedFields

Array<string>

dateFormat

string

Allowed values: DMY MDY YMD

timezone

The organisation’s IANA timezone, which helpers.today() answers in. Read-only: it is taken from the CRM at sign-in, so a pushed value is ignored.

string

<= 64 characters

Example

{
  "modules": [
    {
      "child": {
        "maxRows": "off",
        "layouts": {
          "additionalProperty": {
            "maxRows": "off"
          }
        }
      },
      "stockEffect": {
        "direction": "up"
      }
    }
  ],
  "dateFormat": "DMY"
}

400

The request named no connection (code: CONNECTION_REQUIRED, with connections: the ones this bearer may name). Nothing picks one for a request that does not say (design §14.8).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

401

No bearer, or one that no longer resolves: a session that is unknown or expired (code: AUTH_REQUIRED), or an API token that was revoked or expired (TOKEN_REVOKED, TOKEN_EXPIRED), whose organisation is gone (ORG_NOT_FOUND) or whose member or user row is (MEMBERSHIP_GONE).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low (code: ROLE_REQUIRED), or it was issued for a different organisation; the organisation has been closed (code: ORG_CLOSED, either kind of bearer); the person is banned (code: BANNED, a session); or it is a session that is signed in but in no organisation (code: NO_ORG): one that never joined one, or whose person was taken out of the one it was in, or left it. Signing in again changes nothing for NO_ORG; choosing or making an organisation does.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

?connector= names a connection this person may not use: another organisation’s, or another person’s (code: CONNECTION_NOT_FOUND).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).