createSchedulableResource

mutation · in the family Schedulable resource

What it does

Add a bookable resource — a staff member, station or chair/equipment appointments book against, at one location.

Create a SchedulableResource — a bookable staff/station/equipment entity at an LF; requires the unrestricted capability.

What happens

The kind and location are fixed at creation; capacity says how many bookings may overlap (default 1); working hours are advisory notes the availability view shows.

Who may call it

Capability area: Places and layout — How your organizations and facilities are arranged day to day — facilities, zones and bins, teams and labels.

Owner
System Administrator
Manager
An API key whose scope allows api:createSchedulableResource

Arguments

Name	Type	Required	Notes
`input`	NewSchedulableResourceInput `NewSchedulableResourceInput!`	yes	No further notes.

Returns

SchedulableResource SchedulableResource! — A SchedulableResource — a bookable entity at a LogicalFacility: the staff member / station / equipment Appointments book against. capacity = concurrent bookings (default 1); the confirm gate checks CAPACITY ONLY. workingHours are ADVISORY v1 — naive wall-clock weekly windows (the estate carries no timezone — the map disclosed boundary): the availability read returns them, NO gate consumes them. The OPERATIONAL lifecycle verbatim. The gate: a RESERVED booking (a confirmed/in_progress Appointment) blocks deactivate AND doom, CONFLICT/REFERENCED naming the appointments; requested Appointments deliberately do NOT block (they refuse honestly at confirm via the ACTIVE re-read).

Example request

mutation ExampleCreateSchedulableResource($input: NewSchedulableResourceInput!) {
  createSchedulableResource(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    resourceType
    userId
    capacity
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
    "resourceType": "staff"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createSchedulableResource": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SR-EXMP-0000-000F",
      "type": "SchedulableResource",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "resourceType": "staff",
      "userId": "01900000-0000-7000-8000-11f967df0000",
      "capacity": 1,
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)
CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

Offer appointments on a bookable resource