title: Notendatilkynningaskilaboðategundir audience: developer keywords: tilkynning, notandi, senda, lesa, telja, þráður, skilaboð, Cloud Events Note

locale: is-is

Notendatilkynningaskilaboðategundir

Yfirskjal: API_Reference.md Útfærslumappa: app/src/Message Type/Implementations/Notification/

Yfirlit

Notendatilkynningaskilaboðategundir veita tilkynningavirkni í forriti fyrir Cloud Events samþættingar. Tilkynningar eru vistaðar í Cloud Events Note töflu og afmarkaðar við einstaka notendur. Eiginleikar:

Lesið/ólesið rakning — merkja tilkynningar sem lesnar eða ólesnar í lotu
Þráðun — hópa tengdar tilkynningar eftir þráðarauðkenni og tilvísun í foreldrafærslu
Tengd færsla — tengja tilkynningar við tilteknar BC-færslur (tafla + SystemId)
Tilkynningategundir — flokka tilkynningar (Skilaboð, Samþykki, Kerfi, o.fl.)

Allar lesaðgerðir eru sjálfkrafa afmarkaðar við núverandi notanda (kenni þess sem kallar) í gegnum FilterGroup(2).

Listi yfir skilaboðategundir

Skilaboðategund	Stefna	Tilgangur
User.Notification.Count	Útlæg	Sækja fjölda tilkynninga: heildar, ólesnar og lesnar
User.Notification.Get	Útlæg	Sækja síðaðan lista af tilkynningum
User.Notification.Read	Innlæg	Merkja tilkynningar sem lesnar eða ólesnar
User.Notification.Send	Innlæg	Senda nýja tilkynningu til notanda
User.Notification.Thread	Útlæg	Sækja allar tilkynningar í þræði
Email.Draft.Set	Innlæg	Búa til tölvupóstsdrög í útboxi (HTML + viðhengi, ekki sent)

Sameiginleg uppbygging tilkynningafærslu

Allar útlægar skilaboðategundir skila tilkynningafærslum með þessari JSON-uppbyggingu:

Reitur	Tegund	Lýsing
`entryNo`	Heiltala	Einkvæmt færslunúmer
`threadId`	GUID	Þráðarauðkenni til að hópa samræður
`parentEntryNo`	Heiltala	Foreldrafærslunúmer (0 ef rót)
`recipientUserId`	Code[50]	Kenni viðtakanda
`senderUserId`	Code[50]	Kenni sendanda
`relatedTableId`	Heiltala	Auðkenni tengdrar BC-töflu (0 ef engin)
`relatedRecordSystemId`	GUID	SystemId tengdrar BC-færslu
`approvalEntryNo`	Heiltala	Tengd samþykktarfærsla (0 ef engin)
`subject`	Text[250]	Efnislína tilkynningar
`body`	Texti	Meginmál tilkynningar (úr Blob-reit)
`isRead`	Boolean	Hvort tilkynningin hafi verið lesin
`sourceEntrySystemId`	GUID	SystemId upprunalegrar tilkynningafærslu
`systemId`	GUID	SystemId tilkynningafærslunnar
`systemCreatedAt`	DateTime	Hvenær tilkynningin var stofnuð
`systemModifiedAt`	DateTime	Hvenær tilkynningunni var síðast breytt
`notificationType`	Texti	Heiti tilkynningategundar

Töflutilvísun

Tafla: Cloud Events Note (65327)

Nr.	Heiti	Tegund	Í aðallykli
1	Entry No.	Heiltala	Já
2	Thread ID	GUID	Nei
3	Parent Entry No.	Heiltala	Nei
4	Recipient User ID	Code[50]	Nei
5	Sender User ID	Code[50]	Nei
6	Related Table ID	Heiltala	Nei
7	Related Record SystemId	GUID	Nei
8	Approval Entry No.	Heiltala	Nei
9	Subject	Text[250]	Nei
10	Body	Blob (UTF-8 texti)	Nei
11	Is Read	Boolean	Nei
12	Notification Type	Enum	Nei

Aðgangsreglur

Lesaðgerðir eru afmarkaðar við Recipient User ID = núverandi notandi í gegnum FilterGroup(2).
Skrifaðgerðir (Send) setja Sender User ID sjálfkrafa á núverandi notanda.
Breytingaraðgerðir (Read) hafa aðeins áhrif á færslur þar sem Recipient User ID samsvarar núverandi notanda.

User.Notification.Count

Stefna: Útlæg (svar við beiðni)

Tilgangur: Skilar heildarfjölda, ólesnum og lesnum tilkynningum fyrir núverandi notanda.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "User.Notification.Count",
  "source": "MyApp v1.0"
}

Gagnafæribreytur beiðni

Engar gagnafæribreytur. Engin efnislína eða gagnameginmál er krafist.

Svarsnið

Reitur	Tegund	Lýsing
`status`	Strengur	`"Success"` eða `"Error"`
`total`	Heiltala	Heildarfjöldi tilkynninga fyrir núverandi notanda
`unread`	Heiltala	Ólesnar tilkynningar (Is Read = false)
`read`	Heiltala	Lesnar tilkynningar (Is Read = true)

Dæmi um svar

{
  "status": "Success",
  "total": 25,
  "unread": 10,
  "read": 15
}

Athugasemdir

Niðurstöður eru sjálfkrafa afmarkaðar við núverandi notanda (kenni þess sem kallar)
Fjöldi inniheldur allar tilkynningategundir (skilaboð, samþykktir, kerfistilkynningar)

User.Notification.Get

Stefna: Útlæg (svar við beiðni)

Tilgangur: Sækir síðaðan lista af tilkynningum fyrir núverandi notanda. Styður skip/take síðun og valfrjálsa töflusýnissíu.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "User.Notification.Get",
  "source": "MyApp v1.0",
  "data": "{\"skip\":0,\"take\":20}"
}

Gagnafæribreytur beiðni

Færibreyta	Tegund	Nauðsynleg	Lýsing
`skip`	Heiltala	Nei	Fjöldi færslna sem á að sleppa. Sjálfgefið: 0.
`take`	Heiltala	Nei	Hámarksfjöldi færslna sem á að skila. Sjálfgefið: 50.
`tableView`	Strengur	Nei	BC töflusýnissía.

Dæmi — Sía aðeins ólesnar

{
  "skip": 0,
  "take": 10,
  "tableView": "WHERE(Is Read=CONST(No))"
}

Svarsnið

Reitur	Tegund	Lýsing
`status`	Strengur	`"Success"` eða `"Error"`
`noOfRecords`	Heiltala	Heildarfjöldi færslna sem passa við síu
`result`	Fylki	Fylki af tilkynningahlutum (sjá Sameiginleg uppbygging)

Dæmi um svar

{
  "status": "Success",
  "noOfRecords": 2,
  "result": [
    {
      "entryNo": 1,
      "threadId": "00000000-0000-0000-0000-000000000000",
      "parentEntryNo": 0,
      "recipientUserId": "ADMIN",
      "senderUserId": "SYSTEM",
      "relatedTableId": 0,
      "relatedRecordSystemId": "00000000-0000-0000-0000-000000000000",
      "approvalEntryNo": 0,
      "subject": "Ný pöntun móttekin",
      "body": "Sölupöntun SO-1001 hefur verið stofnuð.",
      "isRead": false,
      "sourceEntrySystemId": "00000000-0000-0000-0000-000000000000",
      "systemId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "systemCreatedAt": "2024-01-15T10:30:00Z",
      "systemModifiedAt": "2024-01-15T10:30:00Z",
      "notificationType": "Message"
    }
  ]
}

Athugasemdir

Niðurstöður eru sjálfkrafa afmarkaðar við núverandi notanda í gegnum FilterGroup(2)
Body-reitur er sjálfkrafa reiknaður (AutoCalcFields) fyrir hverja færslu
Sjálfgefið take er 50 ef ekki tilgreint
Notaðu tableView fyrir síun á þjóni (t.d. aðeins ólesnar, tiltekin tilkynningategund)

User.Notification.Read

Stefna: Innlæg (skrifaðgerð)

Tilgangur: Merkir eina eða fleiri tilkynningar sem lesnar eða ólesnar fyrir núverandi notanda. Breytir aðeins færslum þar sem lesnistæðan breytist í raun.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "User.Notification.Read",
  "source": "MyApp v1.0",
  "data": "{\"entryNos\":[5,8,12]}"
}

Gagnafæribreytur beiðni

Færibreyta	Tegund	Nauðsynleg	Lýsing
`entryNos`	Heiltölufylki	Já	Fylki af færslunúmerum tilkynninga sem á að merkja
`isRead`	Boolean	Nei	Markstaða lestrar. Sjálfgefið: `true`

Dæmi — Merkja sem ólesna

{
  "entryNos": [5],
  "isRead": false
}

Svarsnið

Reitur	Tegund	Lýsing
`status`	Strengur	`"Success"` eða `"Error"`
`noOfRecords`	Heiltala	Fjöldi færslna sem var í raun breytt
`result`	Fylki	Fylki af breyttum tilkynningahlutum (sjá Sameiginleg uppbygging)

Dæmi um svar

{
  "status": "Success",
  "noOfRecords": 2,
  "result": [
    {
      "entryNo": 5,
      "threadId": "00000000-0000-0000-0000-000000000000",
      "parentEntryNo": 0,
      "recipientUserId": "ADMIN",
      "senderUserId": "SYSTEM",
      "relatedTableId": 0,
      "relatedRecordSystemId": "00000000-0000-0000-0000-000000000000",
      "approvalEntryNo": 0,
      "subject": "Samþykki krafist",
      "body": "Innkaupapöntun PO-2001 krefst samþykktar.",
      "isRead": true,
      "sourceEntrySystemId": "00000000-0000-0000-0000-000000000000",
      "systemId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "systemCreatedAt": "2024-01-15T09:00:00Z",
      "systemModifiedAt": "2024-01-15T11:45:00Z",
      "notificationType": "Approval"
    }
  ]
}

Villasvar

{
  "status": "Error",
  "error": "Missing required field 'entryNos' (array of integers) in request."
}

Athugasemdir

Aðeins tilkynningar sem tilheyra núverandi notanda er hægt að breyta
Ef færslunúmer tilheyrir ekki núverandi notanda er því sleppt án villuboða
Aðeins færslur þar sem isRead gildið breytist í raun eru breyttar og skilað
Ef isRead er sleppt er sjálfgefið true (merkja sem lesna)
Svarið inniheldur aðeins færslur sem voru breyttar, ekki allar umbeðnar færslur

User.Notification.Send

Stefna: Innlæg (skrifaðgerð)

Tilgangur: Sendir nýja tilkynningu til tiltekins notanda. Sendandi er sjálfkrafa settur á núverandi notanda (kenni þess sem kallar). Styður þráðun í gegnum threadId og parentEntryNo.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "User.Notification.Send",
  "source": "MyApp v1.0",
  "data": "{\"recipientUserId\":\"JOHN\",\"subject\":\"Verkefni lokið\",\"body\":\"Skýrslan hefur verið búin til.\"}"
}

Gagnafæribreytur beiðni

Færibreyta	Tegund	Nauðsynleg	Lýsing
`recipientUserId`	Texti	Já	Kenni viðtakanda
`subject`	Texti	Já	Efnislína tilkynningar
`body`	Texti	Nei	Meginmál tilkynningar
`threadId`	GUID	Nei	Þráðarauðkenni til að hópa tengdar tilkynningar
`parentEntryNo`	Heiltala	Nei	Foreldrafærslunúmer. Nauðsynlegt ef `threadId` er sett
`relatedTableId`	Heiltala	Nei	Töflunúmer tengdrar BC-færslu
`relatedRecordSystemId`	GUID	Nei	SystemId tengdrar BC-færslu
`notificationType`	Texti	Nei	Heiti tilkynningategundar (t.d. "Approval")

Dæmi — Þráðuð tilkynning með tengdri færslu

{
  "recipientUserId": "JOHN",
  "subject": "Samþykki krafist",
  "body": "PO-2001 þarfnast samþykkis þíns.",
  "threadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "parentEntryNo": 10,
  "relatedTableId": 38,
  "relatedRecordSystemId": "c4d5e6f7-a8b9-0123-cdef-456789012345",
  "notificationType": "Approval"
}

Svarsnið

Skilar stofnaðri tilkynningafærslu:

Reitur	Tegund	Lýsing
`status`	Strengur	`"Success"` eða `"Error"`
`noOfRecords`	Heiltala	Alltaf 1 ef vel heppnast
`result`	Fylki	Fylki sem inniheldur stofnaðan tilkynningahlut (sjá Sameiginleg uppbygging)

Dæmi um svar

{
  "status": "Success",
  "noOfRecords": 1,
  "result": [
    {
      "entryNo": 15,
      "threadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "parentEntryNo": 10,
      "recipientUserId": "JOHN",
      "senderUserId": "ADMIN",
      "relatedTableId": 38,
      "relatedRecordSystemId": "c4d5e6f7-a8b9-0123-cdef-456789012345",
      "approvalEntryNo": 0,
      "subject": "Innkaupapöntun PO-2001 þarfnast samþykkis",
      "body": "Vinsamlegast yfirfarðu og samþykktu innkaupapöntun PO-2001 fyrir lánardrottinn 10000.",
      "isRead": false,
      "sourceEntrySystemId": "00000000-0000-0000-0000-000000000000",
      "systemId": "d5e6f7a8-b9c0-1234-def0-567890123456",
      "systemCreatedAt": "2024-01-15T14:30:00Z",
      "systemModifiedAt": "2024-01-15T14:30:00Z",
      "notificationType": "Approval"
    }
  ]
}

Villasvar

{
  "status": "Error",
  "error": "Missing required field 'recipientUserId' in request."
}

{
  "status": "Error",
  "error": "Missing required field 'parentEntryNo' when 'threadId' is specified."
}

Athugasemdir

Sendandi er alltaf settur á núverandi notanda (kenni þess sem kallar) — ekki hægt að falsa
Ef threadId er gefið er parentEntryNo nauðsynlegt
Nýjar tilkynningar eru alltaf stofnaðar með isRead = false
notificationType vísar í Notification Entry Type enum; óþekkt gildi eru hunsuð

User.Notification.Thread

Stefna: Útlæg (lesaðgerð)

Tilgangur: Sækir allar tilkynningar sem tilheyra tilteknum þræði. Núverandi notandi verður að vera viðtakandi að minnsta kosti einnar tilkynningar í þræðinum.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "User.Notification.Thread",
  "source": "NotificationUI v3.0",
  "subject": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Færibreytur beiðni

Færibreyta	Tegund	Nauðsynleg	Lýsing
`subject`	GUID	Já	Þráðarauðkenni sem GUID-strengur
`skip`	Heiltala	Nei	Fjöldi færslna sem á að sleppa. Sjálfgefið: 0.
`take`	Heiltala	Nei	Hámarksfjöldi færslna sem á að skila. Sjálfgefið: allar.

Dæmi — Þráður með síðun

{
  "specversion": "1.0",
  "type": "User.Notification.Thread",
  "source": "NotificationUI v3.0",
  "subject": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "data": "{\"skip\":0,\"take\":10}"
}

Svarsnið

Reitur	Tegund	Lýsing
`status`	Strengur	`"Success"` eða `"Error"`
`noOfRecords`	Heiltala	Heildarfjöldi færslna í þræðinum
`result`	Fylki	Fylki af tilkynningahlutum (sjá Sameiginleg uppbygging)

Dæmi um svar

{
  "status": "Success",
  "noOfRecords": 2,
  "result": [
    {
      "entryNo": 10,
      "threadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "parentEntryNo": 0,
      "recipientUserId": "JOHN",
      "senderUserId": "ADMIN",
      "relatedTableId": 38,
      "relatedRecordSystemId": "c4d5e6f7-a8b9-0123-cdef-456789012345",
      "approvalEntryNo": 0,
      "subject": "Innkaupapöntun PO-2001 þarfnast samþykkis",
      "body": "Vinsamlegast yfirfarðu og samþykktu.",
      "isRead": true,
      "sourceEntrySystemId": "00000000-0000-0000-0000-000000000000",
      "systemId": "d5e6f7a8-b9c0-1234-def0-567890123456",
      "systemCreatedAt": "2024-01-15T09:00:00Z",
      "systemModifiedAt": "2024-01-15T10:00:00Z",
      "notificationType": "Approval"
    },
    {
      "entryNo": 12,
      "threadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "parentEntryNo": 10,
      "recipientUserId": "ADMIN",
      "senderUserId": "JOHN",
      "relatedTableId": 38,
      "relatedRecordSystemId": "c4d5e6f7-a8b9-0123-cdef-456789012345",
      "approvalEntryNo": 0,
      "subject": "Sv: Innkaupapöntun PO-2001",
      "body": "Samþykkt. Lítur vel út.",
      "isRead": false,
      "sourceEntrySystemId": "00000000-0000-0000-0000-000000000000",
      "systemId": "e6f7a8b9-c0d1-2345-ef01-678901234567",
      "systemCreatedAt": "2024-01-15T10:15:00Z",
      "systemModifiedAt": "2024-01-15T10:15:00Z",
      "notificationType": "Approval"
    }
  ]
}

Villasvar

{
  "status": "Error",
  "error": "The subject must contain the Thread ID (GUID) to retrieve."
}

{
  "status": "Error",
  "error": "No notifications found for the specified Thread ID and current user."
}

Athugasemdir

Efnislínan verður að vera gilt GUID — ógilt snið skilar villu
Núverandi notandi verður að vera viðtakandi að minnsta kosti einnar tilkynningar í þræðinum; annars er villu skilað
Skilar ÖLLUM tilkynningum í þræðinum (frá öllum þátttakendum), ekki bara þeim sem beint er til núverandi notanda
Niðurstöður eru raðaðar eftir færslunúmeri (í tímaröð)

Email.Draft.Set

Stefna: Innlæg (skrifaðgerð)

Tilgangur: Býr til tölvupóstsdrög í Business Central útboxi án þess að senda. Styður HTML meginmál og URL-byggð viðhengi.

Beiðnisnið

{
  "specversion": "1.0",
  "type": "Email.Draft.Set",
  "source": "MyApp v1.0",
  "data": "{\"to\":[\"buyer@contoso.com\"],\"subject\":\"PO 1005\",\"htmlBody\":\"<p>Please review.</p>\",\"relatedTableId\":38,\"attachments\":[{\"fileName\":\"spec.pdf\",\"contentType\":\"application/pdf\",\"url\":\"https://example.com/spec.pdf\"}]}"
}

Gagnafæribreytur beiðni

Færibreyta	Tegund	Nauðsynleg	Lýsing
`to`	Texti eða Text[]	Já	Netfang viðtakanda/viðtakenda. Styður `;`/`,` aðskilinn streng eða fylki.
`subject`	Texti	Já	Efnislína tölvupósts.
`htmlBody`	Texti	Nei	HTML meginmál.
`body`	Texti	Nei	Vara-meginmál ef `htmlBody` vantar.
`cc`	Texti eða Text[]	Nei	CC netföng.
`bcc`	Texti eða Text[]	Nei	BCC netföng.
`emailScenario`	Texti	Nei	Skýrt heiti Email Scenario enum gildis.
`relatedTableId`	Heiltala	Nei	Notað fyrir besta mat á scenario þegar `emailScenario` vantar.
`attachments`	Object[]	Nei	URL-byggð viðhengi. Hver hlutur þarf `fileName` + (`url` eða `contentUrl`).

Svarsnið

Reitur	Tegund	Lýsing
`status`	Strengur	`"Success"` eða `"Error"`
`messageId`	GUID	Auðkenni tölvupóstsdraga
`outboxSystemId`	GUID	SystemId útboxfærslunnar
`outboxUrl`	Strengur	Veffang sem opnar útboxfærslu/drög í viðmóti
`emailScenarioResolved`	Strengur	Upplýst Email Scenario heiti út frá beiðni/samhengi

Athugasemdir

Þessi aðgerð sendir aldrei tölvupóst. Hún vistar aðeins drög í útbox.
Staðlaðar Business Central tölvupóstsheimildir og uppsetning gilda.
Viðhengisslóðir verða að vera aðgengilegar frá Business Central þjóninum.

Webhook-tilkynningar

Fyrir ósamstillta vinnslu (Queue API), gerðu áskrift að External Business Events:

CloudEventMessageCompleted: Tilkynnt þegar vinnsla heppnast
CloudEventMessageFailed: Tilkynnt þegar vinnsla mistekst

Webhook innihald: { MessageId, MessageType: "User.Notification.*", ResponseContentLink, Timestamp }

Notaðu ResponseContentLink til að hlaða niður svari beint, eða notaðu MessageId til að sækja í gegnum Data API. Sjá Events_and_Webhooks.md fyrir uppsetningu.