aYOUne
← Projektmanagement API

Components

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

play_circle 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": {
    "_id": "6a950f92087b451358568bba",
    "name": "MANUAL_AZURE_CORDÉ",
    "color": "#0fff99",
    "count": 0,
    "countOpen": 0,
    "countClosed": 0,
    "progress": 0,
    "tags": [],
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-08-31T05:22:26.859Z",
    "updatedAt": "2026-08-31T05:22:28.842Z",
    "modifiedBy": "6045f4d25704710012485569"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/components/6a950f92087b451358568bba",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "rel": "Modules",
        "title": "MODEL_MODULE",
        "href": "https://api.ayoune.app/pm/modules",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.modules"
      },
      {
        "rel": "Repositories",
        "title": "MODEL_REPOSITORY",
        "href": "https://api.ayoune.app/devops/repositories",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "devops.repositories"
      },
      {
        "rel": "WikiPages",
        "title": "MODEL_WIKIPAGE",
        "href": "https://api.ayoune.app/hub/wikipages",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.wikipages"
      },
      {
        "rel": "KnowledgeBases",
        "title": "MODEL_KNOWLEDGEBASE",
        "href": "https://api.ayoune.app/hub/knowledgebases",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.knowledgebases"
      },
      {
        "rel": "Employees",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hr.employees"
      }
    ],
    "debugId": "6a950f94087b451358568c4f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_COMPONENT",
        "href": "https://api.ayoune.app/pm/components/6a950f92087b451358568bba/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_COMPONENT",
        "href": "https://api.ayoune.app/pm/components/6a950f92087b451358568bba",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.62.0",
      "core": "2026.326.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2452",
      "reset": "1788157331",
      "resetDate": "Mon Aug 31 2026"
    },
    "responseTime": 317.258238,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend