Zum Inhalt springen
aYOUne
← Konfiguration API

Machines

Singular: Machine — Base-URL: https://config-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "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": [],
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "costs": [],
    "tools": [],
    "attributes": [],
    "components": [],
    "createdAt": "2024-02-29T16:26:28.190Z",
    "updatedAt": "2024-02-29T16:26:28.190Z",
    "shares": []
  },
  "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": "MachineGroups",
        "title": "MODEL_MACHINEGROUP",
        "href": "https://api.ayoune.app/config/machinegroups",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.machinegroups"
      },
      {
        "rel": "MachineTypes",
        "title": "MODEL_MACHINETYPE",
        "href": "https://api.ayoune.app/config/machinetypes",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.machinetypes"
      },
      {
        "rel": "CompanyLocations",
        "title": "MODEL_COMPANYLOCATION",
        "href": "https://api.ayoune.app/config/companylocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.companylocations"
      },
      {
        "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": "Assets",
        "title": "MODEL_ASSET",
        "href": "https://api.ayoune.app/accounting/assets",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "accounting.assets"
      },
      {
        "rel": "Machines",
        "title": "MODEL_MACHINE",
        "href": "https://api.ayoune.app/config/machines",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.machines"
      },
      {
        "rel": "Products",
        "title": "MODEL_PRODUCT",
        "href": "https://api.ayoune.app/pim/products",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pim.products"
      },
      {
        "rel": "IoTDevices",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.iotdevices"
      },
      {
        "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"
      },
      {
        "rel": "IoTDevices",
        "title": "MODEL_IOTDEVICE",
        "href": "https://api.ayoune.app/config/iotdevices",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.iotdevices"
      },
      {
        "rel": "BuildingSpaces",
        "title": "MODEL_BUILDINGSPACE",
        "href": "https://api.ayoune.app/config/buildingspaces",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.buildingspaces"
      },
      {
        "rel": "StorageAreas",
        "title": "MODEL_STORAGEAREA",
        "href": "https://api.ayoune.app/config/storageareas",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.storageareas"
      }
    ],
    "debugId": "6ac710771f2ca7f48d9d4963",
    "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",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.367.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "8547",
      "reset": "1791432105",
      "resetDate": "Thu Oct 08 2026"
    },
    "responseTime": 187.786811,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /machines Liste mit Filtern/Paginierung config.machines.view
GET /machines/:id Einzelner Datensatz config.machines.view
POST /machines Neuen Datensatz erstellen config.machines.new
PUT /machines Datensatz aktualisieren config.machines.edit
DELETE /machines/:id Datensatz löschen config.machines.delete

SDK

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

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

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

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

Weiterführend