Vägledning för anslutningssträngar

Följande ämne innehåller allmänna riktlinjer för strängfält i en koppling för Power Automate, Power Apps och Logic Apps.

Information om anslutningsapp

Varje koppling bör ha en titel som är namnet på kopplingen och en beskrivning som beskriver kopplingen i allmänhet. Den här informationen måste anges i fälten för rubrik och beskrivning under avsnittet info i OpenAPI-definitionen (i filen apiDefinition.swagger.json).

Följande riktlinjer är den minsta standard som ska följas för paneler i anslutningsprogrammet och beskrivningar:

• Anslutningsprogrammets rubrik får innehålla högst 30 tecken.
• Anslutningsprogrammets rubrik och beskrivning får inte innehålla ordet API.
• kopplingens rubrik och beskrivning får inte referera till en Power Platform-produkt eller en produkt som du inte äger serverdels-API:erna för.

Riktlinjer med en högre standard för fälten rubrik och beskrivning som framtvingas för certifierade anslutningsprogram finns här och bör användas som bästa praxis.

Operationer

Varje sökväg och verb i OpenAPI-definitionen motsvarar en åtgärd. En tydlig beskrivning av åtgärden med strängarna/taggarna nedan hjälper slutanvändaren att använda den på rätt sätt. Vissa strängfält för en åtgärd är:

• Sammanfattning: detta visas som namnet på åtgärden.

  • Ärende: mening
  • Kommentarer:
    • Det får inte finnas någon snedstreck ('/') i namnet.
    • Det får inte bestå av mer än 80 tecken.
    • Det får inte sluta på ett icke-alfanumeriskt tecken, inklusive skiljetecken och blanksteg.

• beskrivning: Detta visas som åtgärdsbeskrivning när någon väljer informationsknappen information (som på bilden nedan) (som på bilden nedan).

  • Ärende: mening
  • Anteckningar: se till att de får plats i textrutan. Ingen punkt krävs om det bara är ett ord.

• operationId: Detta är det unika ID som är kopplat till åtgärden.

  • Ärende: Camel
  • Obs! Avsedd att förmedla åtgärdens syfte, till exempel GetContacts (hämta kontakter) eller CreateContact (skapa kontakt).

  Bilden nedan visar hur fälten summary (sammanfattning; Skicka ett e-postmeddelande) och description (beskrivning; denna åtgärd skickar ett e-postmeddelande) visas i användargränssnittet när du skapar ett arbetsflöde.

  

Utlösare och åtgärder

En utlösare startar ett arbetsflöde eller en process. Exempel: ”Starta ett arbetsflöde varje måndag kl. 03:00”, ”När ett objekt skapas” och så vidare.

Utlösningen av sammanfattnings- och beskrivningsfälten bör vara läslig och semantisk. Utlösnings översikten brukar vara i formatet: "När en __________________".

Exempel:

Utlösnings beskrivningen är vanligtvis i formatet: "Den här åtgärden utlöses när _______________"

Exempel:

• Åtgärden utlöses när en ny uppgift läggs till.

En åtgärd är en uppgift som ska slutföras i arbetsflödet, till exempel ”Skicka e-post”, ”Uppdatera en rad”, ”Skicka en avisering” och så vidare. Några exempel på åtgärd sammanfattning visas nedan:

Parameters

Varje åtgärd (utlösare eller åtgärd) har parametrar som användaren ger som indata. Några av de viktiga strängfälten för en parameter är:

• x-ms-sammanfattning: Detta visas som parameternamnet.

  • Ärende: rubrik
  • Obs! Namnet får vara högst 80 tecken långt

• beskrivning: Detta visas som parametern beskrivning i inmatningsrutan.

  • Ärende: mening
  • Obs! se till att de får plats i textrutan. Ingen punkt krävs om det bara är ett ord.

  I bilden nedan har den markerade parametern värdet ”Ämne” för fältet x-ms-summary och ”Ange ämne för e-postmeddelandet” som description.

  

Response

Varje åtgärd har ett svar som kan användas längre fram i arbetsflödet som indata i en efterföljande åtgärd. Resultatschemat består av flera egenskaper. Några av de viktiga strängfälten för varje egenskap är:

• x-ms-sammanfattning: Detta visas som resultatets egenskapsnamn.

  • Ärende: rubrik
  • Obs! Använd ett kort namn.

• beskrivning: detta visas som beskrivning för resultategenskapen.

  • Ärende: mening
  • Obs! Bör vara kort och koncis, med en punkt i slutet.

  I bilden nedan visas det resulterande schemat från "manuellt utlösa ett flöde" när du försöker lägga till ett dynamiskt innehåll i en av följande operationer i arbetsflödet. Här är ”Användarens e-post” x-ms-summary och texten nedanför är description för en egenskap som svar på åtgärden ”Utlösa ett flöde manuellt”.

Några viktiga saker att tänka på i allmänhet för fälten summary/x-ms-summary och description är:

• Texten i sammanfattning och beskrivning bör inte vara samma.
• Beskrivningen ska användas för att ge användaren ytterligare information, till exempel utdataformat eller vilket objekt egenskapen tillhör. Till exempel: sammanfattning: ID, beskrivning: användarens ID.
• Om ett objekt har kapslade värden läggs x-ms-summary för det överordnade namnet till i det underordnade namnet.

x-ms-visibility

Anger entitetens synbarhetsprioritet. Om ingen visning anges betraktas det som ”normal” visning. Möjliga värden är ”important” (viktigt), ”advanced” (avancerat) eller ”internal” (internt). Entiteter som har markerats som ”internal” visas inte i användargränssnittet.

Gäller för:

• Operationer
• Parameters
• Svarsegenskaper

Exempel: I användargränssnittet visas vanligtvis objekt som märkts som ”important” först, objekt som märkts som ”advanced” döljs med en växlingskontroll (markerad) och objekt som märkts som ”internal” visas inte. Se till exempel parametrar som är markerade som viktiga i bilden nedan visas som standard och parametrar som är markerade som avancerade visas när du har klickat på knappen Visa avancerade alternativ.