AlmondTill/G3N API

On this page

schedulableResource

query · in the family Schedulable resource

What it does

Look up one bookable resource — its kind, staff link, capacity and working hours.

A SchedulableResource by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.

Returns

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

query ExampleSchedulableResource($id: ID!) {
  schedulableResource(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    resourceType
    userId
    capacity
    code
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "schedulableResource": {
      "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": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer