Benachrichtigungen auflisten
Listet Ihre neuesten Benachrichtigungen auf.
GET/v1/workspaces/{regionId}/notifications
Parameter
audience"buyer" | "supplier"PflichtDer Benachrichtigungs-Feed welcher Seite zurückgegeben wird.
Rückgabe
200 OK mit dem in der Antwort gezeigten Objekt.
Weitere Details
Listet bis zu 50 der neuesten Benachrichtigungen für die angegebene Zielgruppe auf, neueste zuerst. Benachrichtigungen werden 90 Tage aufbewahrt. Verwenden Sie ListNotificationsPage, um ältere seitenweise abzurufen.
Antwortfelder
title, bodystringEnglisch, so wie beim Anlegen der Benachrichtigung geschrieben. Slack, Teams und E-Mail zeigen denselben Text.
titleMessageId, titleParams, bodyMessageId, bodyParamsstring, objectDie Meldung, aus der jeder Text gebildet wurde, und die Werte, mit denen sie gefüllt wurde, damit eine App sie in der Sprache ihrer Leser anzeigen kann. Fehlt bei Benachrichtigungen, die vor Einführung dieser Felder angelegt wurden; zeigen Sie dann title und body an.
resolutionobjectNur bei einer Freigabeanfrage (po_approval_requested, invoice_approval_requested) oder einem Hinweis auf eine fehlende freigebende Person (po_needs_approver, invoice_needs_approver), für die ihr Leser nicht mehr gebraucht wird, beim Auflisten ermittelt und nie gespeichert: outcome you_approved oder you_rejected (mit at), wenn der Leser über den Schritt entschieden hat, sonst no_longer_needed (jemand anderes hat entschieden, der Schritt wurde neu zugewiesen, oder das Dokument hat die Freigabe verlassen). Fehlt, solange der Leser noch gebraucht wird.
Fehler
- 401 Unauthorized - Es wurden keine Zugangsdaten übermittelt, oder der Bearer-Token bzw. der X-Api-Key-Wert fehlt, ist ungültig, abgelaufen oder widerrufen.
- 403 Forbidden - Der Bearer-Token oder API-Schlüssel des Aufrufers gewährt keinen Zugriff auf diesen Workspace (regionId) oder hat nicht die erforderliche Rolle.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/notifications" \
-H "X-Api-Key: $PLEAXY_API_KEY"[
{
"id": "string",
"audience": "buyer" | "supplier",
"type": "report_ready" | "company_report_ready" | "po_approved" | "po_rejected" | "po_canceled" | "po_changed" | "po_approval_requested" | "request_approval_requested" | "request_approved" | "request_rejected" | "request_ordered" | "po_store_order_problem" | "po_supplier_confirmed" | "po_supplier_exception" | "po_shipped" | "po_supplier_email" | "po_changes_declined" | "po_needs_approver" | "invoice_submitted" | "invoice_ready_for_approval" | "invoice_approval_requested" | "invoice_discrepancy" | "invoice_approved" | "invoice_paid" | "invoice_payment_withdrawn" | "payments_recorded_by_key" | "accounting_sync_failed" | "invoice_remittance_sent" | "invoice_payment_failed" | "invoice_reminder" | "invoice_rejected" | "invoice_on_hold" | "invoice_hold_released" | "invoice_payment_reminder" | "invoice_entered_by_buyer" | "invoice_bank_details_to_confirm" | "invoice_bank_details_confirmed" | "invoice_bank_details_disputed" | "invoice_bank_details_changed" | "invoice_needs_approver" | "ses_approval_requested" | "ses_auto_approved" | "ses_approved" | "ses_rejected" | "receipt_return_recorded" | "po_line_due" | "po_line_due_asked" | "po_receipt_requested" | "invoice_held_due_soon" | "ses_approval_overdue" | "credit_note_received" | "credit_note_accepted" | "credit_note_rejected" | "credit_note_applied" | "invoice_comment" | "po_comment" | "contract_comment" | "invoice_feed_changed" | "supplier_connection_invited" | "supplier_connection_submitted" | "supplier_connection_approved" | "supplier_connection_rejected" | "supplier_connection_region_mismatch" | "agent_request" | "support_case_opened" | "support_case_updated" | "supplier_late_fee_terms_changed" | "contract_terms_to_acknowledge" | "contract_terms_acknowledged" | "contract_terms_disputed" | "contract_recheck_requested" | "contract_sent_to_joined_supplier" | "copilot_allowance_80" | "copilot_allowance_100" | "copilot_degraded" | "copilot_packs_low" | "copilot_packs_empty" | "copilot_payg_cap",
"title": "string",
"body": "string",
"titleMessageId": "string",
"titleParams": { },
"bodyMessageId": "string",
"bodyParams": { },
"relatedId": "string",
"createdAt": "string",
"read": boolean,
"resolution": { "outcome": "you_approved" | "you_rejected" | "no_longer_needed", "at": "string" }
}
]