aYOUne
← Projektmanagement API

PmRequirements

Singular: PmRequirement — 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": "6a950ff3087b45135856ab08",
    "name": "COLD_CRIMSON_DORMÉ",
    "status": "draft",
    "goals": [],
    "outOfScope": [],
    "tags": [],
    "_techWriters": [],
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "assumptions": [],
    "questions": [],
    "createdAt": "2026-08-31T05:24:03.716Z",
    "updatedAt": "2026-08-31T05:24:03.716Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/pmrequirements/6a950ff3087b45135856ab08",
        "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": "Milestones",
        "title": "MODEL_MILESTONE",
        "href": "https://api.ayoune.app/pm/milestones",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.milestones"
      },
      {
        "rel": "Epics",
        "title": "MODEL_EPIC",
        "href": "https://api.ayoune.app/pm/epics",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.epics"
      },
      {
        "rel": "Features",
        "title": "MODEL_FEATURE",
        "href": "https://api.ayoune.app/pm/features",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.features"
      }
    ],
    "debugId": "6a950ff4087b45135856ab3b",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PMREQUIREMENT",
        "href": "https://api.ayoune.app/pm/pmrequirements/6a950ff3087b45135856ab08/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PMREQUIREMENT",
        "href": "https://api.ayoune.app/pm/pmrequirements/6a950ff3087b45135856ab08",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.62.0",
      "core": "2026.326.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2115",
      "reset": "1788157331",
      "resetDate": "Mon Aug 31 2026"
    },
    "responseTime": 181.068505,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend