Lýsigögn - Skilaboðategundir

Þetta skjal lýsir Lýsigagna (Help) skilaboðategunum sem eru í boði í Cloud Events API til að sækja kerfisgögn lýsigögn og skjöl.

Yfirskjal: API_Reference.md

Útfærslumappa: app/src/Message Type/Implementations/Metadata/ og app/src/Message Type/Implementations/Field/

Yfirlit

Lýsigagna-skilaboðategundir bjóða upp á aðgerðir til að uppgötva og skilja BC gagnagrunnsuppbygginguna, tiltækar skilaboðategundir, reitarlýsigögn og heimildir notanda. Þessar skilaboðategundir eru nauðsynlegar til að smíða gangvirkar samþætttingar sem aðlagast gagnagrunnsuppbyggingunni og tiltækum aðgerðum.

Skráðar skilaboðategundir:

1. Help.Tables.Get

Tilgangur: Sækja lista yfir allar tiltækar töflur í gagnagrunni.

Lýsing: Skilar lista yfir allar tiltækar töflur í gagnagrunni með auðkenni þeirra, heiti, birtitexta og nafnrými.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

Engar færibreytur eru nauðsynlegar. Valfrjálst er að sía að tiltekinni töflu með einhverri af þessum aðferðum:

• tableName í gagnaumboðinu (t.d. "Customer")
• tableNumber í gagnaumboðinu (t.d. 18)
• tableNo í gagnaumboðinu (samheiti fyrir tableNumber)
• tableId í gagnaumboðinu (samheiti fyrir tableNumber)
• subject reitur í CloudEvents umslagi — töfluheiti eða númer

Tungumálastuðningur:

Til að fá birtitexta á tilteknu tungumáli, stilltu lcid reitinn (Windows Language ID) á skilaboðastigi CloudEvents (ekki í gagnaumboðinu).

Algeng LCID gildi:

Snið svars:

{
  "status": "Success",
  "result": [
    {
      "id": 18,
      "name": "Customer",
      "caption": "Customer",
      "dataPerCompany": true,
      "namespace": "Microsoft.Sales.Customer",
      "readRestricted": false,
      "writeRestricted": false
    },
    {
      "id": 23,
      "name": "Vendor",
      "caption": "Vendor",
      "dataPerCompany": true,
      "namespace": "Microsoft.Purchases.Vendor",
      "readRestricted": false,
      "writeRestricted": false
    }
  ]
}

Svarreitir:

• id: Töflunúmer
• name: Töfluheiti
• caption: Töflubirtiheiti á umbeðnu tungumáli (eða sjálfgefnu tungumáli úr Cloud Events Setup ef lcid er ekki tilgreint)
• dataPerCompany: Boolean — true ef taflan geymir gögn per fyrirtæki; false fyrir deildar (altækar) töflur
• namespace: AL nafnrými töflunnar (t.d. "Microsoft.Sales.Customer") — tómur strengur fyrir töflur án nafnrýmis
• readRestricted: Boolean — true þegar taflan er læst fyrir Data.Records.Get. Innþi Cloud Events / Change Log kerfistöflur og ekki-venjulegar töflutegundir eru leshömluðu.
• writeRestricted: Boolean — true þegar taflan er læst fyrir Data.Records.Set. Nær yfir allar leshömluðu töflur auk Cloud Event Message (lestur leyfður, skrift læst).

Dæmi um notkun:

Dæmi 1 — Skila öllum töflum:

{
  "specversion": "1.0",
  "type": "Help.Tables.Get",
  "source": "MyIntegrationApp v1.0"
}

*Dæmi 2 — Sía að tiltekinni töflu með tableName:*

{
  "specversion": "1.0",
  "type": "Help.Tables.Get",
  "source": "MyIntegrationApp v1.0",
  "data": {
    "tableName": "Customer"
  }
}

Dæmi 3 — Allar töflur á tilteknu tungumáli:

{
  "specversion": "1.0",
  "type": "Help.Tables.Get",
  "source": "MyIntegrationApp v1.0",
  "lcid": 1039
}

2. Help.Fields.Get

Tilgangur: Sækja reitarlýsigögn fyrir tilgreinda töflu.

Lýsing: Sækir reitarlýsigögn fyrir tilgreinda töflu þ.m.t. reitanúmer, heiti, birtitexta, tegund, lengd og stöðu sem aðallykils hluta.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

{
  "tableName": "Customer"
}

Eða með tilgreindum reitum:

{
  "tableName": "Customer",
  "fieldNumbers": [1, 2, 21, 61]
}

Tungumálastuðningur: Sama og Help.Tables.Get — stilltu lcid á skilaboðastigi.

Snið svars:

{
  "status": "Success",
  "result": [
    {
      "id": 1,
      "name": "No.",
      "jsonName": "No_",
      "caption": "No.",
      "class": "Normal",
      "type": "Code",
      "len": 20,
      "isPartOfPrimaryKey": true,
      "readRestricted": false,
      "writeRestricted": false
    },
    {
      "id": 2,
      "name": "Name",
      "jsonName": "Name",
      "caption": "Name",
      "class": "Normal",
      "type": "Text",
      "len": 100,
      "isPartOfPrimaryKey": false,
      "readRestricted": false,
      "writeRestricted": false
    },
    {
      "id": 21,
      "name": "Balance (LCY)",
      "jsonName": "BalanceLCY",
      "caption": "Balance (LCY)",
      "class": "FlowField",
      "type": "Decimal",
      "len": 0,
      "isPartOfPrimaryKey": false,
      "readRestricted": false,
      "writeRestricted": true
    },
    {
      "id": 35,
      "name": "Date Filter",
      "jsonName": "DateFilter",
      "caption": "Date Filter",
      "class": "FlowFilter",
      "type": "Date",
      "len": 0,
      "isPartOfPrimaryKey": false,
      "readRestricted": false,
      "writeRestricted": false
    },
    {
      "id": 3,
      "name": "Blocked",
      "jsonName": "Blocked",
      "caption": "Blocked",
      "class": "Normal",
      "type": "Option",
      "len": 0,
      "isPartOfPrimaryKey": false,
      "readRestricted": false,
      "writeRestricted": false,
      "enum": [
        { "value": " ", "caption": " ", "ordinal": 0 },
        { "value": "Ship", "caption": "Ship", "ordinal": 1 },
        { "value": "Invoice", "caption": "Invoice", "ordinal": 2 },
        { "value": "All", "caption": "All", "ordinal": 3 }
      ]
    }
  ]
}

Lýsigögn reita:

• id: Reitanúmer
• name: Reitnafn
• jsonName: Staðlað reitnafn notað í JSON-svörum (sértákn skipt út gegn undirstrikum)
• caption: Reitbirtiheiti á umbeðnu tungumáli
• class: Reitaflokkur — "Normal" fyrir venjulega reiti, "FlowField" fyrir reiknaða reiti, "FlowFilter" fyrir síuvíddareiti (notaðir í tableView)
• type: Gagnategund reits
• len: Lengd reits (0 fyrir tölulegar, option og FlowField reiti)
• isPartOfPrimaryKey: Hvort reitur sé hluti aðallykils
• readRestricted: Hvort virkur notandi sé með leshömlun á reitnum samkvæmt Cloud Events Field Access (hömlunargerð Both eða Read, eða samsvörim alttákn). Þegar true, sleppir Data.Records.Get reitnum úr svari án villu.
• writeRestricted: Hvort virkur notandi sé með skrifhömlun á reitnum samkvæmt Cloud Events Field Access (hömlunargerð Both eða Write, eða samsvörim alttákn). Þegar true, hafnar Data.Records.Set skrifum á reitnum.
• enum (aðeins fyrir Option reiti): Fylki af enum gildum, hvert með value (innri nafn), caption (birtiheiti) og ordinal (heiltölugildi)

Dæmi um notkun:

{
  "specversion": "1.0",
  "type": "Help.Fields.Get",
  "source": "MyIntegrationApp v1.0",
  "subject": "Customer",
  "lcid": 1039
}

3. Help.MessageTypes.Get

Tilgangur: Sækja lista yfir allar tiltækar skilaboðategundir með lýsigögn þeirra.

Lýsing: Skilar lista yfir allar tiltækar skilaboðategundir með lýsigögn þeirra þ.m.t. síutöflunúmer, lýsingu og stefnu skilaboða.

Stefna skilaboða: Útlæg

Inntaksfæribreytur: Engar nauðsynlegar.

Snið svars:

{
  "status": "Success",
  "result": [
    {
      "name": "Data.RecordIds.Get",
      "filterTableNo": 0,
      "description": "Sækir færsluauðkenni og breytingartímastimpla...",
      "messageDirection": "Outbound"
    },
    {
      "name": "Help.Tables.Get",
      "filterTableNo": 0,
      "description": "Skilar lista yfir allar tiltækar töflur...",
      "messageDirection": "Outbound"
    }
  ]
}

Lýsigögnasreitir:

• name: Heiti skilaboðategund
• filterTableNo: Töflunúmer sía (ef við á, 0 þýðir á við allar töflur)
• description: Lýsing á skilaboðategundinni
• messageDirection: Stefna skilaboða (Inbound/Outbound/Both)

Dæmi um notkun:

{
  "specversion": "1.0",
  "type": "Help.MessageTypes.Get",
  "source": "MyIntegrationApp v1.0"
}

4. Help.Implementation.Get

Tilgangur: Sækja hjálparskjölun fyrir tilgreinda skilaboðategund.

Lýsing: Skilar hjálparskjölun fyrir tilgreinda skilaboðategund. Tilgreindu heiti skilaboðategund í subject reitnum.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

Heiti skilaboðategundar verður að vera tilgreint í subject reitnum:

{
  "subject": "Help.Tables.Get"
}

Snið svars:

Skilar hjálparskjöluninni á text/markdown sniði. Svarið inniheldur nákvæmar skjölun þ.m.t.:

• Yfirlit yfir aðgerðir skilaboðategundar
• Sniðbeiðni og færibreytur
• Uppbyggingu svars
• Dæmi
• Villutilvik
• Bestu venjur

Villutilvik:

1. Vantar subject reit

• Villa: "Subject field must contain the message type name (e.g., 'Help.Tables.Get')"

1. Ógild skilaboðategund

• Villa: "Message type '{name}' is not valid or not found."

5. Help.Permissions.Get

Tilgangur: Sækja les- og skrifaheimildir núverandi notanda fyrir tilgreinda töflu.

Lýsing: Sækir les- og skrifaheimildir núverandi notanda fyrir tilgreinda töflu með RecordRef.ReadPermission() og RecordRef.WritePermission() aðferðunum.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

{
  "tableName": "Customer"
}

Snið svars:

{
  "status": "Success",
  "permissions": {
    "read": true,
    "write": false
  }
}

Heimildireitir:

• read: Boolean sem gefur til kynna hvort núverandi notandi hafi lesheimild á töfluna
• write: Boolean sem gefur til kynna hvort núverandi notandi hafi skrifaheimild (setja inn/breyta/eyða) á töfluna

Dæmi um notkun:

{
  "specversion": "1.0",
  "type": "Help.Permissions.Get",
  "source": "MyIntegrationApp v1.0",
  "subject": "Customer"
}

{
  "specversion": "1.0",
  "type": "Help.Permissions.Get",
  "source": "MyIntegrationApp v1.0",
  "subject": "G/L Account"
}

Heimildalög

Aðgangur að gögnum gegnum Cloud Events API er stýrt af tveimur óháðum lögum. Beiðni heppnast aðeins þegar bæði lögin leyfa hana.

1. BC heimild (það sem þessi skilaboðategund skilar)

• Uppspretta: BC heimildasett notandans, ásamt InherentPermissions á AL hlutum.
• Umfang: öll taflan (les / setja inn / breyta / eyða).
• Þegar hafnað: Data.Records.* skilar heimildavillu frá BC vettvanginum.

1. Cloud Events takmarkanir (uppsettar per notanda í Cloud Events Field Access)

• Uppspretta: Cloud Events Field Access taflan, viðhaldin af Cloud Events stjórnendum.
• Umfang: per tafla og per reitur, með takmörkunartegundunum Read, Write, Both eða Bypass.
• Þegar hafnað: Data.Records.Get sleppir reitnum þegjandi úr svari; Data.Records.Set hafnar skrifun með villu; Create skilaboðategundir (Sales.Document.Create, Purchase.Document.Create, Inventory.AssemblyOrder.Create, Inventory.TransferOrder.Create, Finance.BankReconciliation.Create) neita að stofna færsluna þegar aðalreiturinn er skrifa-takmarkaður.

Virkur aðgangur — uppflettitafla

Hvernig á að leysa heildarmyndina

Til að vita hvort núverandi notandi getur í raun lesið eða skrifað í tilgreinda töflu eða reit, kallaðu allar þrjár uppspretturnar og sameinaðu þær:

1. BC heimild á töflu — kallaðu Help.Permissions.Get (þessa skilaboðategund). Les permissions.read og permissions.write.
2. Cloud Events takmörkun á töflu — kallaðu Help.Tables.Get með auðkenni töflu. Hver tafla í niðurstöðu inniheldur readRestricted og writeRestricted táknfána á töflustigi.
3. Cloud Events takmörkun á einstökum reitum — kallaðu Help.Fields.Get með auðkenni töflu. Hver reitur í niðurstöðu inniheldur readRestricted og writeRestricted fána sem leyst eru gegn núverandi notanda.

Sameina lögin:

• canReadField = Help.Permissions.Get.permissions.read AND NOT Help.Tables.Get.readRestricted AND NOT Help.Fields.Get.readRestricted
• canWriteField = Help.Permissions.Get.permissions.write AND NOT Help.Tables.Get.writeRestricted AND NOT Help.Fields.Get.writeRestricted

6. Help.NextLineNo.Get

Tilgangur: Skila næsta tiltæka línunúmeri fyrir hvaða töflu sem síðasti aðallyklireitur er Integer.

Lýsing: Gefið foreldri aðallykil gildi (með primaryKey JSON hlut eða SystemId), útfærslan síar á þeim foreldri reitum, kallar FindLast og skilar næsta gildi sem lastLineNo + increment. Svarið inniheldur fullkominn primaryKey hlut sem hægt er að senda beint til Data.Records.Set.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

\* Nákvæmlega eitt af primaryKey eða id verður að vera gefið. Ef bæði eru til staðar, hefur id forgang.

Snið svars:

{
  "status": "Success",
  "primaryKey": {
    "DocumentType": "Order",
    "DocumentNo": "S-ORD-001",
    "LineNo": 40000
  }
}

Dæmi um notkun:

{
  "specversion": "1.0",
  "type": "Help.NextLineNo.Get",
  "source": "external",
  "datacontenttype": "application/json",
  "data": {
    "tableName": "Sales Line",
    "primaryKey": {
      "DocumentType": "Order",
      "DocumentNo": "S-ORD-001"
    },
    "increment": 10000
  }
}

7. Field.Translation.Get

Tilgangur: Sækja BC kerfisþýðingar fyrir tiltekinn reit á færslu.

Lýsing: Sækir geymdri þýðingu á færslureit með kóðaeiningu 3711 "Translation". Krefst tiltekins tungumáls (lcid). Skilar sléttri JSON svari með þýðingargildinu.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

Athugið: lcid færibreytan verður að vera gefin í beiðni JSON gagnaumboðinu, ekki á CloudEvents skilaboðastigi.

Snið svars:

{
  "status": "Success",
  "tableId": 27,
  "systemId": "12345678-1234-1234-1234-123456789012",
  "fieldId": 3,
  "lcid": 1039,
  "value": "Borð úr tré"
}

Dæmi um notkun:

{
  "specversion": "1.0",
  "type": "Field.Translation.Get",
  "source": "MyApp v1.0",
  "subject": "Item",
  "data": {
    "systemId": "12345678-1234-1234-1234-123456789012",
    "fieldId": 3,
    "lcid": 1039
  }
}

Help.PageUrl.Get

Tilgangur: Skila Business Central vefslóð fyrir spjaldsíðu tiltekinnar færslu.

Lýsing: Leyst er úr töflu og færslu SystemId með stöðluðum beiðnisniðum í argument-töflunni, skilyrt spjaldsíða er fundin með kóðaeiningunni Page Management, og vefslóð síðunnar er skilað. Aðeins er skilað Success þegar vefslóðin fæst og er ekki tóm.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

\ Töfluauðkenni er nauðsynlegt. \\* Færsluauðkenni er nauðsynlegt.

Snið svars:

Efnisgerð svars (Content Type): text/json

{
  "status": "Success",
  "url": "https://businesscentral.dynamics.com/..."
}

Svarreitir:

Dæmi um notkun (tafla í gögnum, auðkenni í gögnum):

{
  "specversion": "1.0",
  "type": "Help.PageUrl.Get",
  "source": "external",
  "id": "pageurl-001",
  "datacontenttype": "application/json",
  "data": {
    "tableName": "Customer",
    "id": "a0e2b3c4-d5e6-7890-abcd-ef1234567890"
  }
}

Dæmi um notkun (tafla í subject, recordSystemId í gögnum):

{
  "specversion": "1.0",
  "type": "Help.PageUrl.Get",
  "source": "external",
  "subject": "Customer",
  "datacontenttype": "application/json",
  "data": {
    "recordSystemId": "a0e2b3c4-d5e6-7890-abcd-ef1234567890"
  }
}

Villuskilaboð:

• Vantar töfluauðkenni: "Table identifier is required. Provide tableName, tableNumber, tableNo, tableId, or subject."
• Vantar færsluauðkenni: "Record identifier is required. Provide id, systemId, recordId, recordSystemId, or a GUID subject."
• Færsla fannst ekki: "Record not found in table {tableId} with SystemId {guid}."
• Engin spjaldsíðuslóð: "No card page URL could be resolved for table '{tableCaption}' and record {guid}."

8. Field.Translation.Set

Tilgangur: Skrifa eða eyða BC kerfisþýðingu fyrir tiltekinn reit á færslu.

Lýsing: Skrifar eina þýðingu á færslureit með kóðaeiningu 3711 "Translation". Til að eyða þýðingu, sendu tómt gildi fyrir tilgreint tungumál.

Stefna skilaboða: Innlæg

Inntaksfæribreytur:

Snið svars:

{
  "status": "Success",
  "tableId": 27,
  "systemId": "12345678-1234-1234-1234-123456789012",
  "fieldId": 3,
  "lcid": 1039,
  "value": "Borð úr tré"
}

Dæmi 1 — Stilla þýðingu á reit (íslenska):

{
  "specversion": "1.0",
  "type": "Field.Translation.Set",
  "source": "MyApp v1.0",
  "data": {
    "tableName": "Item",
    "systemId": "12345678-1234-1234-1234-123456789012",
    "fieldId": 3,
    "lcid": 1039,
    "value": "Borð úr tré"
  }
}

Dæmi 2 — Eyða þýðingu (senda tómt gildi):

{
  "specversion": "1.0",
  "type": "Field.Translation.Set",
  "source": "MyApp v1.0",
  "subject": "Item",
  "data": {
    "systemId": "12345678-1234-1234-1234-123456789012",
    "fieldId": 3,
    "lcid": 1039,
    "value": ""
  }
}

9. Field.Translations.Get

Tilgangur: Sækja BC kerfisþýðingar fyrir alla reiti (eða tiltekinn reit) á færslu.

Lýsing: Sækir allar geymdar þýðingar á færslu með kóðaeiningu 3711 "Translation". Ólíkt Field.Translation.Get (eintala), skilar þessi endapunktur þýðingum yfir marga reiti, þar sem hver færsla inniheldur fieldId. Valfrjálst síað eftir reit og/eða tungumáli.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

Snið svars:

{
  "status": "Success",
  "tableId": 27,
  "systemId": "12345678-1234-1234-1234-123456789012",
  "translationCount": 4,
  "translations": [
    { "fieldId": 3, "languageId": 1039, "value": "Borð úr tré" },
    { "fieldId": 3, "languageId": 1040, "value": "Scrivania" },
    { "fieldId": 5, "languageId": 1039, "value": "Tré" },
    { "fieldId": 5, "languageId": 1040, "value": "Legno" }
  ]
}

Svarreitir:

Samþætttingarmynstur

Mynstur 1: Uppbygging kerfisuppgötvunar

Skref 1: Fá allar töflur

{
  "type": "Help.Tables.Get"
}

Skref 2: Fá reiti fyrir tilgreinda töflu

{
  "type": "Help.Fields.Get",
  "subject": "Customer"
}

Skref 3: Athuga heimildir notanda

{
  "type": "Help.Permissions.Get",
  "subject": "Customer"
}

Skref 4: Sækja gögn ef leyft

{
  "type": "Data.Records.Get",
  "data": {
    "tableName": "Customer"
  }
}

Help.WhoAmI.Get

Útfærsla: HelpWhoAmIGetImpl (Codeunit 65438) Hjálpar-kóðaeining: HelpWhoAmIGetHelp (Codeunit 65439) Stefna: Útlæg

Tilgangur

Skilar yfirgripsmiklu notandasniði fyrir þann sem kallar. Svarið inniheldur BC-stillingar, hlutverkatengingar, tengdar starfsmanns-/tilfanga-/sölumannaupplýsingar, fyrirtækjaupplýsingar, valfrjálsar tengdar viðskiptafærslur (viðskiptamaður, lánardrottinn, tengiliður, fjárhagsreikningur), valfrjálsa kerfisboðskipun sem geymd er í CE notandauppsetningu og upplýsingar um hvort notandinn hafi skrifheimildir á fyrirtækjaminni.

Ytri gervigreindakerfi nota þetta til að finna út við hvern þau eiga samskipti og til að sækja notendabundið samhengi.

Inntak

Engar inntaksfæribreytur eru nauðsynlegar. Skilaboðategundin notar samhengi köllunarinnar.

{
  "specversion": "1.0",
  "type": "Help.WhoAmI.Get",
  "source": "external",
  "id": "whoami-001",
  "datacontenttype": "application/json",
  "data": {}
}

Svarsnið

{
  "status": "Success",
  "user": {
    "userSecurityId": "a1b2c3d4-...",
    "userName": "DOMAIN\\USER",
    "fullName": "Jón Jónsson",
    "contactEmail": "jon@example.com",
    "authenticationEmail": "jon@example.com"
  },
  "personalization": {
    "profileId": "BUSINESS MANAGER",
    "languageId": 1039,
    "localeId": 1039,
    "company": "CRONUS Iceland hf.",
    "timeZone": "UTC"
  },
  "userSetup": {
    "userId": "JON",
    "salesPurchCode": "JS",
    "approverId": "MANAGER1",
    "salesRespCtrFilter": "",
    "purchaseRespCtrFilter": "",
    "serviceRespCtrFilter": "",
    "allowPostingFrom": "2025-01-01",
    "allowPostingTo": "2025-12-31",
    "timeSheetAdmin": false,
    "email": "jon@example.com"
  },
  "approvalSetup": {
    "approverId": "MANAGER1",
    "approvalAdministrator": false,
    "unlimitedSalesApproval": false,
    "unlimitedPurchaseApproval": false,
    "unlimitedRequestApproval": false,
    "salesAmountApprovalLimit": 10000,
    "purchaseAmountApprovalLimit": 5000,
    "requestAmountApprovalLimit": 5000,
    "substitute": "JON2"
  },
  "notificationSetup": [
    {
      "notificationType": "New Record",
      "notificationMethod": "Email",
      "recurrence": "Daily",
      "time": "08:00:00",
      "dailyFrequency": "Weekday"
    }
  ],
  "resource": {
    "no": "JS",
    "name": "Jón Jónsson",
    "type": "Person"
  },
  "salesperson": {
    "code": "JS",
    "name": "Jón Jónsson",
    "email": "jon@example.com",
    "phoneNo": "+354 555 1234"
  },
  "employee": {
    "no": "EMP001",
    "firstName": "Jón",
    "lastName": "Jónsson",
    "socialSecurityNo": "010180-1234",
    "email": "jon@example.com",
    "phoneNo": "+354 555 1234",
    "jobTitle": "Forritari",
    "managerNo": "EMP002",
    "resourceNo": "JS"
  },
  "manager": {
    "no": "EMP002",
    "firstName": "Anna",
    "lastName": "Sigurðardóttir",
    "email": "anna@example.com",
    "phoneNo": "+354 555 5678",
    "jobTitle": "Teymisformaður"
  },
  "companyInfo": {
    "name": "CRONUS Iceland hf.",
    "name2": "",
    "address": "Laugavegur 123",
    "city": "Reykjavík",
    "postCode": "101",
    "countryRegionCode": "IS",
    "phoneNo": "+354 555 0000",
    "email": "info@company.is",
    "homePage": "https://company.is",
    "vatRegistrationNo": "123456-7890",
    "registrationNo": "1234567890"
  },
  "warehouseLocations": [
    { "locationCode": "BLUE", "default": true, "adcsUser": false },
    { "locationCode": "GREEN", "default": false, "adcsUser": false }
  ],
  "responsibilityCenters": {
    "salesRespCtrFilter": "AÐAL",
    "purchaseRespCtrFilter": "",
    "serviceRespCtrFilter": ""
  },
  "dueFromToOwner": {
    "glAccountNo": "33050",
    "name": "Arður",
    "balanceAtDate": 150000.00,
    "netChange": 25000.00
  },
  "customer": {
    "no": "10000",
    "name": "Contoso ehf.",
    "address": "Laugavegur 123",
    "city": "Reykjavík",
    "postCode": "101",
    "phoneNo": "+354 555 1234",
    "email": "info@contoso.is",
    "creditLimitLCY": 500000.00,
    "balanceLCY": 120000.00,
    "balanceDueLCY": 15000.00
  },
  "vendor": {
    "no": "20000",
    "name": "Fabrikam ehf.",
    "address": "Glerártorg 456",
    "city": "Akureyri",
    "postCode": "600",
    "phoneNo": "+354 555 5678",
    "email": "ap@fabrikam.is",
    "balanceLCY": 85000.00,
    "balanceDueLCY": 10000.00
  },
  "contact": {
    "no": "CT000001",
    "name": "Anna Jónsdóttir",
    "address": "Álmtré 789",
    "city": "Reykjavík",
    "postCode": "105",
    "phoneNo": "+354 555 9012",
    "email": "anna@example.com",
    "type": "Person",
    "companyNo": "CT000000",
    "companyName": "Contoso ehf."
  },
  "systemPrompt": "Þú ert hjálplegur aðstoðarmaður fyrir söluhópinn okkar...",
  "unreadNotifications": [
    {
      "sender": "ADMIN",
      "subject": "Eftirfylgni vegna pöntunar",
      "threadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "canUpdateCompanyMemory": true,
  "canSendAndCancelApprovalRequests": true
}

Svarsreitir

Sérhver reitur skilar null þegar samsvarandi færsla finnst ekki eða notandi hefur ekki leseheimildir.

Tengdar færslur - yfirskriftar (CE notandauppsetning)

CE notandauppsetningin getur geymt tengireitir á hvern notanda sem yfirskrifa sjálfgefna uppflettingu og bæta við hlutum í svarið:

Sjá Setup_Reference.md → Cloud Events notandauppsetning fyrir nánari stillingarleiðbeiningar.

Villumeðhöndlun

Þessi skilaboðategund gefur ekki villur vegna færslna sem vantar. Hver gagnahluti skilar sjálfstætt null þegar samsvarandi færsla finnst ekki eða notandi hefur ekki leseheimildir. Eina villan kemur upp þegar óstudd skilaboðaútgáfa er notuð (ekki 1.0).

10. Help.TableRelations.Get

Tilgangur: Skilar öllum ytri lyklasamböndum sem eru skilgreindar á tilteknum töflureit, þar með taldar skilyrt greiningasamböndsgreinar og öfug sambönd (reitir í öðrum töflum sem vísa til þessa reitar).

Lýsing: Les úr kerfistöflunni Table Relations Metadata (2000000140) til að skila sérhverri samböndsgrein sem er skilgreind fyrir upprunareit töflu, ásamt relatedTo fylki sem listar öfug sambönd — reitir í öðrum töflum sem vísa til tilgreindrar töflu og reitar sem ytri lykilmark. Bæði töflu- og reitarauðkenning er nauðsynleg. Reitir með mörg skilyrt sambönd birtast sem margar raðir með fullum skilyrðisupplýsingum.

Stefna skilaboða: Útlæg

Inntaksfæribreytur:

\* Eitt af fieldId, fieldNo eða fieldName er nauðsynlegt.

Svarsnið:

{
  "status": "Success",
  "tableId": 37,
  "tableName": "Sales Line",
  "relationCount": 2,
  "relations": [
    {
      "tableId": 37,
      "fieldNo": 6,
      "fieldName": "No.",
      "fieldJsonName": "No_",
      "relationNo": 1,
      "relatedTableId": 15,
      "relatedTableName": "G/L Account",
      "relatedFieldNo": 0,
      "relatedFieldName": "(Primary Key)",
      "relatedFieldJsonName": "PrimaryKey",
      "conditionType": "Const",
      "conditionFieldNo": 5,
      "conditionFieldName": "Type",
      "conditionFieldJsonName": "Type",
      "conditionValue": " "
    },
    {
      "tableId": 37,
      "fieldNo": 6,
      "fieldName": "No.",
      "fieldJsonName": "No_",
      "relationNo": 2,
      "relatedTableId": 27,
      "relatedTableName": "Item",
      "relatedFieldNo": 0,
      "relatedFieldName": "(Primary Key)",
      "relatedFieldJsonName": "PrimaryKey",
      "conditionType": "Const",
      "conditionFieldNo": 5,
      "conditionFieldName": "Type",
      "conditionFieldJsonName": "Type",
      "conditionValue": "Item"
    }
  ],
  "relatedToCount": 0,
  "relatedTo": []
}

Athugið: Í þessu dæmi (Sales Line reiturinn "No.") er relatedTo tómt vegna þess að engin önnur tafla vísar til Sales Line.No. sem ytri lykilmark. Fyrir reit eins og Customer."No." myndi relatedTo fylkið innihalda færslur frá Sales Header, Sales Line og öðrum töflum sem vísa til viðskiptamanns.

Svarsreitir (umslag):

Sambandsobjektareitir:

Bæði relations og relatedTo fylkin nota sömu hlutagerð:

Skilyrðisgerðir:

Villumeðhöndlun:

Reitur sem engin önnur tafla vísar til skilar relatedToCount: 0 og tómu relatedTo fylki. Reitur án útleiddra samböndna skilar relationCount: 0 og tómu relations fylki.

Dæmi um notkun (sía eftir reitarheiti):

{
  "specversion": "1.0",
  "type": "Help.TableRelations.Get",
  "source": "external",
  "id": "tablerel-001",
  "datacontenttype": "application/json",
  "data": {
    "tableName": "Sales Line",
    "fieldName": "No."
  }
}

Dæmi um notkun (sía eftir reitarnúmeri):

{
  "specversion": "1.0",
  "type": "Help.TableRelations.Get",
  "source": "external",
  "id": "tablerel-002",
  "datacontenttype": "application/json",
  "data": {
    "tableName": "Customer",
    "fieldNo": 35
  }
}

Dæmi um notkun (sía eftir töflunúmeri og reitarauðkenni):

{
  "specversion": "1.0",
  "type": "Help.TableRelations.Get",
  "source": "external",
  "id": "tablerel-003",
  "datacontenttype": "application/json",
  "data": {
    "tableNumber": 18,
    "fieldId": 1
  }
}

Help.CloudEvents.Get

Stefna: Útlæg Flokkur: Lýsigögn

Yfirlit

Skilar stuttu Markdown-yfirliti yfir alla Help.* uppgötvunarendapunkta og leiðbeinir kallaranum að sækja fullan tæknileiðarvísi um Cloud Events API með Help.Implementation.Get og subject = "Help.CloudEvents.Get". Notist þegar AI-umboðsmaður eða samþætting þarf fljótlegt kort yfir tiltæka endapunkta án þess að sækja allan tæknitexta strax.

Dæmi um beiðni

{
  "type": "Help.CloudEvents.Get",
  "subject": "",
  "data": {}
}

Engar færibreytur. subject og data eru hunsuð.

Dæmi um svar

{
  "status": "Success",
  "result": {
    "messageType": "Help.CloudEvents.Get",
    "format": "markdown",
    "markdown": "# Cloud Events API - Help endpoints\n\nThis response is a short directory. ...",
    "fullHelpInstructions": "Call Help.Implementation.Get with subject=\"Help.CloudEvents.Get\" to retrieve the full technical Cloud Events API how-to guide as Markdown."
  }
}

Svarreitir

Hvernig á að sækja fullan tæknileiðarvísi

{
  "type": "Help.Implementation.Get",
  "subject": "Help.CloudEvents.Get",
  "data": {}
}

Reiturinn markdown í svari inniheldur fulla tækniumfjöllun: talning færslna, samtölur á þjóni, FlowFields/FlowFilters, tableView málskipan, form aðallykla, upsert-semantík, gjaldmiðlameðhöndlun, tvíundarreiti, Change Log Write Guard og LCID-meðhöndlun.

Tengdar skilaboðategundir

• Help.Implementation.Get — fullur tækni­leiðarvísir á hverja skilaboðategund
• Help.MessageTypes.Get — talning allra skilaboðategunda
• Help.Tables.Get, Help.Fields.Get — lýsigagnauppgötvun

Tengd skjöl

• API_Reference.md: API-endapunktar og auðkenning
• Data_Message_Types.md: Gagnasækja og vinnslu skilaboðategundir
• Sales_Message_Types.md: Sölu og viðskiptagreind skilaboðategundir
• Setup_Reference.md: Cloud Events uppsetningarstillingar

© Origo – Cloud Events Base Extension