Leum gu prìomh susbaint

Cruth Tachartas Fo-sgrìobhaidh

Airson an iomradh canonical freagarrach do AI air an schema, thoir sùil air Subscription Event Schema.

Tha fo-sgrìobhaidhean GraphQL a’ cur air ais pacaid lìbhrigidh tana agus cnapan-tachartais còdaichte ann an JSON.

Pacaid Lìbhrigidh

Tha freagairtean feed cleachdaiche coltach ri:

{
"data": "{\"version\":\"1.0\",\"eventId\":\"evt...\",\"timestamp\":\"2026-04-24T10:38:36.822Z\",\"level\":\"INFO\",\"event\":\"recipientVisiting\",\"category\":\"recipientLifecycle\",\"groupId\":\"grp...\",\"userId\":\"usr...\",\"requestId\":null,\"batchId\":null,\"error\":null,\"data\":{\"id\":\"rec...\",\"documentId\":\"doc...\",\"documentName\":\"Example document\",\"firstName\":\"Ada\",\"lastName\":\"Lovelace\"}}",
"userId": "..."
}

Bidh freagairtean feed buidheann a’ cleachdadh groupId an àite userId anns a’ phacaid a-muigh.

Tha am pacaid a’ comharrachadh sianal fo-sgrìobhaidh. Tha an sreang data a-staigh na phàigheadh tachartais canonical.

Cnap-tachartais

An dèidh sgèileadh data, gheibh thu:

{
"version": "1.0",
"eventId": "evt...",
"timestamp": "2026-04-24T10:38:36.822Z",
"level": "INFO",
"event": "recipientVisiting",
"category": "recipientLifecycle",
"groupId": "grp...",
"userId": "usr...",
"requestId": null,
"batchId": null,
"error": null,
"data": {
"id": "rec...",
"documentId": "doc...",
"documentName": "Example document",
"firstName": "Ada",
"lastName": "Lovelace"
}
}

Raointean Cnap-tachartais

RaonTuairisgeul
versionDreach cnap-tachartais. An-dràsta 1.0.
eventIdID tachartais reusanta seasmhach. Tha leth-bhreacan fanout den aon tachartas a’ roinn an luach seo.
timestampÙine tachartais ISO-8601.
levelDoimhneachd tachartais. Mar as trice INFO an-dràsta.
eventAinm tachartais canonical leithid documentArchived no uploadCompleted.
categoryTeaghlach tachartais. Tha seo a’ mìneachadh mar a leughas tu data.
groupIdCo-theacsa buidhne ma thachair e.
userIdCo-theacsa neach-cleachdaidh ma thachair e.
requestIdID co-cheangail iarrtais ma tha e ri fhaighinn.
batchIdCo-theacsa baidse ma tha e ri fhaighinn.
errorPàigheadh mhearachdan ma thachair, air neo null.
dataPàigheadh sònraichte do roinn.

Roinnean

Na roinnean làithreach:

  • document
  • recipient
  • documentLifecycle
  • recipientLifecycle
  • template
  • task
  • upload
  • credit

‘category’ ag innse dè an nì no sruth-obrach mun tachartas. ‘event’ ag innse dè thachair.

Cruthan Data

Tha data sònraichte do roinn agus comasach air leudachadh san àm ri teachd:

  • Faodaidh luchd-tasgaidh raointean a chur ris thar ùine.
  • Cha bu chòir do luchd-tasgaidh raointean a tharraing air falbh mar a chailleas iad co-fhreagarrachd.
  • Bu chòir do luchd-cleachdaidh raointean nach aithne dhaibh a leigeil seachad.

Cruthan bunaiteach làithreach:

// document
{ "id": "doc..." }

// recipient
{ "id": "rec...", "documentId": "doc..." }

// documentLifecycle
{ "id": "doc...", "documentName": "Example document" }

// recipientLifecycle
{
"id": "rec...",
"documentId": "doc...",
"documentName": "Example document",
"firstName": "Ada",
"lastName": "Lovelace"
}

// template
{ "id": "tpl..." }

// task
{ "id": "tsk...", "code": "TSKPROCESSOK", "documents": [] }

// upload
{ "id": "tmp...", "key": "upload/usr.../tmp....pdf", "code": "UPLOADOK" }

// credit
{ "credit": 172 }

Tha dàta beatha nas beairtiche air a lìonadh a-nis gu cunbhalach as motha airson tachartasan documentLifecycle agus recipientLifecycle.

Export This Article

Save a copy of this page as PDF or plain text.