aYOUne
← Service Desk API

Announcements

Singular: Announcement — Base-URL: https://service-api.ayoune.app — Zugriff: CRUD

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": {
    "wayBack": {
      "field": "",
      "value": "",
      "actionText": ""
    },
    "_id": "65e0b1fd121b7d48fe15a65e",
    "title": "",
    "typ": "message",
    "body": "",
    "link": "",
    "linkText": "",
    "public": false,
    "restrictInternal": false,
    "kinds": [
      "customer",
      "lead",
      "partner",
      "affiliate"
    ],
    "departments": [],
    "createdBy": "6045f4d25704710012485569",
    "from": "2024-02-29T16:34:05.365Z",
    "to": "2024-02-29T16:34:05.365Z",
    "createdAt": "2024-02-29T16:34:05.366Z",
    "updatedAt": "2024-02-29T16:34:05.366Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://service-api.ayoune.app/announcements/65e0b1fd121b7d48fe15a65e",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "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": "Articles",
        "title": "MODEL_ARTICLE",
        "href": "https://api.ayoune.app/cms/articles",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.articles"
      },
      {
        "rel": "WikiPages",
        "title": "MODEL_WIKIPAGE",
        "href": "https://api.ayoune.app/hub/wikipages",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.wikipages"
      }
    ],
    "debugId": "6a6199cce4b54de427d220b3",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ANNOUNCEMENT",
        "href": "https://api.ayoune.app/service/announcements/65e0b1fd121b7d48fe15a65e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ANNOUNCEMENT",
        "href": "https://api.ayoune.app/service/announcements/65e0b1fd121b7d48fe15a65e/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.4.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2492",
      "reset": "1784784859",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 82.190159,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

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

SDK

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

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

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

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

Weiterführend