Skip to content
aYOUne
← Configuration API

TerminalRoles

Singular: TerminalRole — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6a30b01e1ab613e8ec61f8e5",
    "key": "production",
    "active": true,
    "createdAt": "2026-06-16T02:08:30.735Z",
    "defaultRoute": "/production",
    "enabledModules": [
      "production"
    ],
    "icon": "precision_manufacturing",
    "isDraft": true,
    "isSeed": true,
    "label": "Production",
    "sortOrder": 10,
    "updatedAt": "2026-06-16T02:30:26.084Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/terminalroles/6a30b01e1ab613e8ec61f8e5",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "WorkCenters",
        "title": "MODEL_WORKCENTER",
        "href": "https://api.ayoune.app/production/workcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.workcenters"
      }
    ],
    "debugId": "6adec7e262556e5404c0db14",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_TERMINALROLE",
        "href": "https://api.ayoune.app/config/terminalroles/6a30b01e1ab613e8ec61f8e5/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_TERMINALROLE",
        "href": "https://api.ayoune.app/config/terminalroles/6a30b01e1ab613e8ec61f8e5",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "7043",
      "reset": "1792987338",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 104.512305,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /terminalroles List with filters/pagination config.terminalroles.view
GET /terminalroles/:id Single record config.terminalroles.view
POST /terminalroles Create new record config.terminalroles.new
PUT /terminalroles Update record config.terminalroles.edit
DELETE /terminalroles/:id Delete record config.terminalroles.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.terminalRoles.find().limit(10).exec();

// Single record
const one = await ay.config.terminalRoles.findById('OBJECT_ID').exec();

// Create
const created = await ay.config.terminalRoles.create({ name: 'Foo' });

See also