aYOUne
← Projektmanagement API

Workflows

Singular: Workflow — 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": {
    "notifySpec": {
      "enabled": true,
      "level": "info",
      "channels": []
    },
    "_id": "6a8d10ba0d04c8139da35f41",
    "key": "application-default",
    "name": "Bewerbung – Standardprozess",
    "description": "Plattform-Vorgabe für den Bewerbungs-Lebenszyklus. Mandanten-Kopie (mit _customerID) überschreibt sie, HRJobs._applicationWorkflow überschreibt beide.",
    "entityCollection": "Applications",
    "statuses": [
      {
        "name": "new",
        "labelKey": "hr.applications.status.new",
        "isInitial": true,
        "isTerminal": false,
        "color": "#0068a5",
        "icon": "inbox"
      },
      {
        "name": "screening",
        "labelKey": "hr.applications.status.screening",
        "isInitial": false,
        "isTerminal": false,
        "color": "#8a6d3b",
        "icon": "search"
      },
      {
        "name": "interview",
        "labelKey": "hr.applications.status.interview",
        "isInitial": false,
        "isTerminal": false,
        "color": "#6f42c1",
        "icon": "groups"
      },
      {
        "name": "offer",
        "labelKey": "hr.applications.status.offer",
        "isInitial": false,
        "isTerminal": false,
        "color": "#14746f",
        "icon": "draft"
      },
      {
        "name": "hired",
        "labelKey": "hr.applications.status.hired",
        "isInitial": false,
        "isTerminal": true,
        "color": "#2e7d32",
        "icon": "how_to_reg"
      },
      {
        "name": "rejected",
        "labelKey": "hr.applications.status.rejected",
        "isInitial": false,
        "isTerminal": true,
        "color": "#b3261e",
        "icon": "cancel"
      },
      {
        "name": "withdrawn",
        "labelKey": "hr.applications.status.withdrawn",
        "isInitial": false,
        "isTerminal": true,
        "color": "#5f6368",
        "icon": "undo"
      },
      {
        "name": "on-hold",
        "labelKey": "hr.applications.status.on-hold",
        "isInitial": false,
        "isTerminal": false,
        "color": "#9e6b00",
        "icon": "pause"
      }
    ],
    "transitions": [
      {
        "notifySpec": {
          "channels": []
        },
        "from": "new",
        "to": "screening",
        "event": "advance",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "advanced"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "screening",
        "to": "interview",
        "event": "advance",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "advanced"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "interview",
        "to": "offer",
        "event": "advance",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "advanced"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "interview",
        "to": "offer",
        "event": "send-offer",
        "requiredRoles": [],
        "requiredFields": [
          "offer"
        ],
        "emits": "offer-sent"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "offer",
        "to": "hired",
        "event": "accept-offer",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "hired"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "offer",
        "to": "rejected",
        "event": "decline-offer",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "offer-declined"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "*",
        "to": "rejected",
        "event": "reject",
        "requiredRoles": [],
        "requiredFields": [
          "rejection"
        ],
        "emits": "rejected"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "*",
        "to": "withdrawn",
        "event": "withdraw",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "withdrawn"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "*",
        "to": "on-hold",
        "event": "hold",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "held"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "on-hold",
        "to": "screening",
        "event": "resume",
        "requiredRoles": [],
        "requiredFields": [],
        "emits": "resumed"
      },
      {
        "notifySpec": {
          "channels": []
        },
        "from": "rejected",
        "to": "screening",
        "event": "reopen",
        "requiredRoles": [
          "hr.applications.edit"
        ],
        "requiredFields": [],
        "emits": "reopened"
      }
    ],
    "isSystem": false,
    "schemaVersion": 1,
    "isDraft": true,
    "createdAt": "2026-08-25T03:49:14.970Z",
    "updatedAt": "2026-08-25T03:49:14.970Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/workflows/6a8d10ba0d04c8139da35f41",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a950ff9087b45135856aca1",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_WORKFLOW",
        "href": "https://api.ayoune.app/pm/workflows/6a8d10ba0d04c8139da35f41/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_WORKFLOW",
        "href": "https://api.ayoune.app/pm/workflows/6a8d10ba0d04c8139da35f41",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.62.0",
      "core": "2026.326.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2099",
      "reset": "1788157331",
      "resetDate": "Mon Aug 31 2026"
    },
    "responseTime": 305.936517,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend