aYOUne
← Configuration API

Machines

Singular: Machine — Base URL: https://config-api.ayoune.app — Access: CRUD

play_circle 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": {
    "loc": {
      "type": "Point",
      "coordinates": [
        0,
        0
      ]
    },
    "_id": "65e0b034121b7d48fe1577e7",
    "kind": "machine",
    "name": "-",
    "desc": "-",
    "useAdvancedCosts": false,
    "useCostGroup": false,
    "cph": 0,
    "cpm": 0,
    "cpd": 0,
    "status": "",
    "serial": "",
    "utilization": false,
    "needsSkill": false,
    "needsWorker": false,
    "needsWorkerAmount": 1,
    "defaultWorkers": [],
    "workers": [],
    "needsUtilization": false,
    "utilizationMode": "dimension",
    "maxWeight": 10000000,
    "maxWeightUnit": "Kilogramm",
    "maxWidth": 10000000,
    "maxWidthUnit": "Meter",
    "maxLength": 10000000,
    "maxLengthUnit": "Meter",
    "maxHeight": 10000000,
    "maxHeightUnit": "Meter",
    "maxVolume": 10000000,
    "maxVolumeUnit": "Kubikmeter",
    "runTime": 10,
    "startUpTime": 10,
    "coolDownTime": 10,
    "timeEfficiency": 100,
    "capacity": 1,
    "oeeTarget": 95,
    "oee": 0,
    "lost": 0,
    "load": 0,
    "performance": 0,
    "resources": [],
    "createdBy": "6045f4d25704710012485569",
    "costs": [],
    "tools": [],
    "attributes": [],
    "components": [],
    "createdAt": "2024-02-29T16:26:28.190Z",
    "updatedAt": "2024-02-29T16:26:28.190Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/machines/65e0b034121b7d48fe1577e7",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "ProductionLines",
        "title": "MODEL_PRODUCTIONLINE",
        "href": "https://api.ayoune.app/config/productionlines",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.productionlines"
      },
      {
        "rel": "Locations",
        "title": "MODEL_LOCATION",
        "href": "https://api.ayoune.app/config/locations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.locations"
      },
      {
        "rel": "Departments",
        "title": "MODEL_DEPARTMENT",
        "href": "https://api.ayoune.app/config/departments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.departments"
      },
      {
        "rel": "CostCenters",
        "title": "MODEL_COSTCENTER",
        "href": "https://api.ayoune.app/accounting/costcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "accounting.costcenters"
      },
      {
        "rel": "CostGroups",
        "title": "MODEL_COSTGROUP",
        "href": "https://api.ayoune.app/config/costgroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.costgroups"
      },
      {
        "rel": "Skills",
        "title": "MODEL_SKILL",
        "href": "https://api.ayoune.app/config/skills",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.skills"
      }
    ],
    "debugId": "6a62dde0f27d6098834ad538",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_MACHINE",
        "href": "https://api.ayoune.app/config/machines/65e0b034121b7d48fe1577e7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_MACHINE",
        "href": "https://api.ayoune.app/config/machines/65e0b034121b7d48fe1577e7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1289",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 269.723083,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also