Agilite (förhandsversion)
Med Agilit-e kan du centralisera affärslogik och processer och exponera dem som mikrotjänster för nya eller befintliga program. Med Agilit-e-anslutningsappen får du åtkomst till många tjänster, inklusive Business Process Management (BPM), roller, nyckelord, mallar med mera.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | Agilit-e-supportteam |
| URL | https://agilite.io |
| E-postmeddelande | support@agilite.io |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | Agilit-e |
| Webbplats | https://agilite.io |
| Sekretesspolicy | https://agilite.io/privacy-policy/ |
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Shareable |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är en delningsbar anslutning. Om power-appen delas med en annan användare delas även anslutningen. Mer information finns i Översikt över anslutningsappar för arbetsyteappar – Power Apps | Microsoft Docs
| Namn | Typ | Description | Krävs |
|---|---|---|---|
| Ange URL för Agilit-e API Server. (Använd förhttps://api.agilite.io Agilit-e Cloud) | snöre | Ange URL för Agilit-e API Server. (Använd förhttps://api.agilite.io Agilit-e Cloud) | Sann |
| API-nyckel (genereras i underhttps://portal.agilite.io Administration) | securestring | API-nyckel (genereras i underhttps://portal.agilite.io Administration) | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Generera tal (numrering) |
Genererar ett unikt nummer baserat på "profilnyckel" som tillhandahålls |
| Hämta efter profilnyckel (BPM) |
Hämta den fullständiga BPM-profilen med konfiguration och alternativ för processen. |
| Hämta efter profilnyckel (nyckelord) |
Returnerar nyckel-/värdepar för en specifik nyckelordsprofil baserat på den angivna profilnyckeln |
| Hämta etikett efter värde (nyckelord) |
Returnerar en nyckelordsetikett baserat på den angivna profilnyckeln och värdenyckeln |
| Hämta posttillstånd (BPM) |
Hämta BPM-posttillstånd för en eller flera poster som ska innehålla den aktuella statusen, vem som ansvarar för posten, arbetsflödeshistoriken och annan information för att beskriva det aktuella tillståndet och reglerna för posten |
| Hämta profilnycklar efter grupp (nyckelord) |
Returnerar alla nyckelordsprofilnycklar baserat på det angivna gruppnamnet |
| Hämta roll (roller) |
Hämta ansvariga personer som har tilldelats roller i Agilit-e-administratörsportalen. Dessa roller är inte bara relevanta för specifika poster eller affärsprocesser och används vanligtvis för företagsomfattande roller i organisationen |
| Hämta tilldelade roller (roller) |
Hämta ansvariga personer för tidigare tilldelad roll för en viss post |
| Hämta värde efter etikett (nyckelord) |
Returnerar ett nyckelordsvärde baserat på den angivna profilnyckeln och etikettnyckeln |
| Kör (BPM) |
Skickar ett alternativ i det aktuella arbetsflödessteget. Beroende på affärsreglerna går posten vidare till nästa steg i processen och returnerar information om nästa steg till api:et för anrop |
| Kör (mallar) |
Bearbetar och returnerar en mall från Agilit-e baserat på den angivna profilnyckeln |
| Registrera BPM-post (BPM) |
Registrera ny BPM-post. Posten tilldelas ett recordID som används för postens livscykel för att identifiera posten, dess förlopp, historik och status hela tiden |
| Tilldela roll (roller) |
Tilldela den användardefinierade roll som gäller för en viss post. Ett exempel på detta skulle vara en dokumentgranskare eller en leave-godkännare |
Generera tal (numrering)
Genererar ett unikt nummer baserat på "profilnyckel" som tillhandahålls
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Profilnyckel
|
profile-key | True | string |
Unik nyckel för målprofilen |
|
|
object |
Returer
- Body
- StdJSONResponse
Hämta efter profilnyckel (BPM)
Hämta den fullständiga BPM-profilen med konfiguration och alternativ för processen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Profilnyckel
|
profile-key | True | string |
Unik nyckel för målprofilen |
Returer
- Body
- GetBPMProfile
Hämta efter profilnyckel (nyckelord)
Returnerar nyckel-/värdepar för en specifik nyckelordsprofil baserat på den angivna profilnyckeln
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Profilnyckel
|
profile-key | True | string |
Unik nyckel för målprofilen |
|
Sortera
|
sort | string |
En valfri parameter för att sortera det returnerade nyckel-/värderesultatet |
Returer
- Föremål
- KeywordValues
Hämta etikett efter värde (nyckelord)
Returnerar en nyckelordsetikett baserat på den angivna profilnyckeln och värdenyckeln
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Profilnyckel
|
profile-key | True | string |
Unik nyckel för målprofilen |
|
Värdenyckel
|
value-key | True | string |
Värdenyckeln i listan Etikett/värde för målprofilen |
Returer
- Body
- StdJSONResponse
Hämta posttillstånd (BPM)
Hämta BPM-posttillstånd för en eller flera poster som ska innehålla den aktuella statusen, vem som ansvarar för posten, arbetsflödeshistoriken och annan information för att beskriva det aktuella tillståndet och reglerna för posten
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Processnycklar
|
process-keys | string |
Filtrera för att identifiera de affärsprocesser som posterna ska returneras för. Den här nyckeln finns på BPM-profilen i Agilit-e-administratörsportalen – (separat med kommatecken) |
|
|
BPM-post-ID:n
|
bpm-record-ids | string |
filtrera för att endast returnera poster med specifika recordIds. RecordId registreras av registerBPMRecord-API:et för nya poster och finns i egenskapen recordID för BPM api-svar – (avgränsa med kommatecken) |
|
|
Stegnamn
|
step-names | string |
Filtrera för att endast returnera poster som för närvarande är till de angivna arbetsflödesstegen – (avgränsa med kommatecken) |
|
|
Ansvarsfulla användare
|
responsible-users | string |
Filtrera om du bara vill returnera poster som för närvarande är tilldelade till angivna e-postadresser – (avgränsa med kommatecken) |
|
|
Relevanta användare
|
relevant-users | string |
Filtrera för att endast returnera poster som är relevanta för angivna e-postadresser – (avgränsa med kommatecken) |
|
|
Inkludera historik
|
include-history | boolean |
Ange om historikobjektet ska returneras med posttillståndsinformationen |
|
|
Inkludera stegalternativ
|
include-step-options | boolean |
Ange om objektet för stegalternativ ska returneras med posttillståndsinformationen |
|
|
Inkludera synliga objekt
|
include-visible-objects | boolean |
Ange om objektet synliga objekt ska returneras med posttillståndsinformationen |
Returer
- Föremål
- GetBPMRecordState
Hämta profilnycklar efter grupp (nyckelord)
Returnerar alla nyckelordsprofilnycklar baserat på det angivna gruppnamnet
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Gruppnamn
|
group-name | True | string |
Gruppnamnet som används för att gruppera nyckelordsprofiler |
|
Sortera
|
sort | string |
En valfri parameter för att sortera det returnerade nyckel-/värderesultatet |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
|
array of string |
Hämta roll (roller)
Hämta ansvariga personer som har tilldelats roller i Agilit-e-administratörsportalen. Dessa roller är inte bara relevanta för specifika poster eller affärsprocesser och används vanligtvis för företagsomfattande roller i organisationen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Rollnamn
|
role-names | True | string |
Ange de rollnamn som du vill hämta ansvariga användare för – (avgränsa med kommatecken) |
|
Villkorsstyrda nivåer
|
conditional-levels | string |
Ange ytterligare nivåer som kan användas för att fastställa rätt person för rollen. Ett exempel på en nivå kan vara ett avdelningsnamn (om du vill hämta avdelningschefen) eller ett produktnamn (om du vill hämta Produkthanteraren) – (avgränsa med kommatecken) |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
responsibleUsers
|
responsibleUsers | array of string |
responsibleUsers |
Hämta tilldelade roller (roller)
Hämta ansvariga personer för tidigare tilldelad roll för en viss post
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Processnyckel
|
process-key | True | string |
Unik nyckel för målprofilen |
|
BPM-post-ID
|
bpm-record-id | True | string |
Identifierar den post som rollen har angetts för. ID:t registreras av registerBPMRecord-API:et för nya poster och finns i egenskapen recordID för BPM api-svar |
|
Rollnamn
|
role-names | True | string |
De roller som ska frågas (avgränsas med kommatecken) |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
|
array of object | ||
|
Namn
|
name | string | |
|
Users
|
users | array of object | |
|
E-postmeddelande
|
users.email | string |
Hämta värde efter etikett (nyckelord)
Returnerar ett nyckelordsvärde baserat på den angivna profilnyckeln och etikettnyckeln
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Profilnyckel
|
profile-key | True | string |
Unik nyckel för målprofilen |
|
Etikettnyckel
|
label-key | True | string |
Etikettnyckeln i listan Etikett/Värde för målprofilen |
Returer
- Body
- StdJSONResponse
Kör (BPM)
Skickar ett alternativ i det aktuella arbetsflödessteget. Beroende på affärsreglerna går posten vidare till nästa steg i processen och returnerar information om nästa steg till api:et för anrop
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Processnyckel
|
process-key | True | string |
Unik nyckel för målprofilen |
|
BPM-post-ID
|
bpm-record-id | True | string |
Identifierar den post som skickas. ID:t registreras av registerBPMRecord-API:et för nya poster och finns i egenskapen recordID för BPM api-svar |
|
Valt alternativ
|
option-selected | True | string |
Identifierar det alternativ som väljs av användaren som ska köras som en del av överföringsprocessen. Det här värdet måste motsvara ett giltigt stegalternativ i arbetsflödesprofilen |
|
Aktuell användare
|
current-user | True | string |
E-postadressen till den användare som skickar BPM-steget. Detta är vanligtvis den användare som loggas in när api:et anropas |
|
Stegkommentarer för arbetsflöde
|
comments | string |
Skickar kommentarer till körningsprocessen som kommer att stämplas i arbetsflödeshistoriken. Detta används vanligtvis om användaren avvisar ett steg eller begär mer information |
|
|
|
object |
Returer
- Body
- ExecuteBPMResult
Kör (mallar)
Bearbetar och returnerar en mall från Agilit-e baserat på den angivna profilnyckeln
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Profilnyckel
|
profile-key | True | string |
Unik nyckel för målprofilen |
|
|
object |
Returer
- Body
- StdJSONResponse
Registrera BPM-post (BPM)
Registrera ny BPM-post. Posten tilldelas ett recordID som används för postens livscykel för att identifiera posten, dess förlopp, historik och status hela tiden
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Processnyckel
|
process-key | True | string |
Unik nyckel för målprofilen |
|
Aktuell användare
|
current-user | True | string |
E-postadressen till den användare som registrerar posten. Detta är vanligtvis den användare som loggas in när api:et anropas |
Returer
- Body
- RegisterBPMRecord
Tilldela roll (roller)
Tilldela den användardefinierade roll som gäller för en viss post. Ett exempel på detta skulle vara en dokumentgranskare eller en leave-godkännare
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Processnyckel
|
process-key | True | string |
Unik nyckel för målprofilen |
|
BPM-post-ID
|
bpm-record-id | True | string |
Identifierar den post som rollen har angetts för. ID:t registreras av registerBPMRecord-API:et för nya poster och finns i egenskapen recordID för BPM api-svar |
|
Aktuell användare
|
current-user | True | string |
E-postadressen till den användare som anger rollen. Detta är vanligtvis den användare som loggas in när api:et anropas |
|
Rollnamn
|
role-name | True | string |
Namnet på den roll som tilldelas. T.ex. godkännare eller granskare |
|
Ansvarsfulla användare
|
responsible-users | True | string |
E-postadresserna till de användare som har tilldelats den här rollen – (avgränsa med kommatecken) |
Returer
data
- data
- object
Definitioner
ExecuteBPMResult
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Beskrivning av processsteg
|
description | string |
En kort beskrivning som förklarar processsteget |
|
SLA-varaktighet (hrs)
|
duration | string |
SLA-varaktigheten i timmar. Ange värdet 0 om det inte är tillämpligt |
|
Händelsestämpel för processsteg
|
eventStamp | string |
En händelsestämpel för det aktuella processsteget |
|
Steginstruktioner
|
instructions | string |
Instruktioner till ansvarig användare under steg |
|
Processstegnyckel
|
key | string |
En unik nyckel för att identifiera processsteget |
|
Namn på processsteg
|
name | string |
Ett kort namn för processsteget |
|
BPM-profilnyckel
|
processKey | string |
En unik nyckel för att identifiera BPM-profilen |
|
Processtadium
|
processStage | string |
En nyckel som definierar processsteget i det aktuella steget |
|
Ansvarstyp
|
responsibility | string |
Användar-/rollbaserat ansvar |
|
Ansvarig roll för processsteg
|
responsibleRole | string |
Rollen som ansvarar för det aktuella processsteget |
|
Processstegsansvariga användare
|
responsibleUsers | array of string |
De användare som ansvarar för det aktuella processsteget |
|
stepOptions
|
stepOptions | array of object | |
|
Beskrivning av stegalternativ
|
stepOptions.description | string |
En kort beskrivning som förklarar stegalternativet |
|
Händelsestämpel för stegalternativ
|
stepOptions.eventStamp | array of string |
En händelsestämpel för det aktuella stegalternativet |
|
Namn på stegalternativ
|
stepOptions.name | string |
Ett kort namn för stegalternativet |
|
Nästa steg
|
stepOptions.nextStep | string |
Nästa steg som affärsprocessen dirigeras till. Lämna tomt om inga ytterligare steg |
|
Stegalternativanteckningar
|
stepOptions.notes | string |
Valfritt alternativ för anteckningar för steg |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Objekt-ID för stegalternativ
|
stepOptions.visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
stepOptions.visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
stepOptions.visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är stegalternativobjekt redigerbart
|
stepOptions.visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är stegalternativobjekt obligatoriskt
|
stepOptions.visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
|
visibleObjects
|
visibleObjects | array of object | |
|
Objekt-ID för processsteg
|
visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är processstegsobjektet redigerbart
|
visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är processstegsobjekt obligatoriskt
|
visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
GetBPMProfile
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
appAdmin
|
appAdmin | array of object | |
|
E-post för appadministratör
|
appAdmin.email | string |
En e-postadress för administratören för den aktuella BPM-profilen |
|
URL för BPM-app
|
appUrl | string |
En valfri URL för appen som använder den aktuella BPM-profilen |
|
Beskrivning av BPM-profil
|
description | string |
En kort beskrivning som förklarar BPM-profilen |
|
Namn på BPM-profilgrupp
|
groupName | string |
En valfri gruppering för BPM-profilen |
|
BPM-profilnyckel
|
key | string |
En unik nyckel för att identifiera BPM-profilen |
|
BPM-profilnamn
|
name | string |
Ett kort namn för BPM-profilen |
|
BPM-profilanteckningar
|
notes | string |
Valfria anteckningar för BPM-profil |
|
processSteps
|
processSteps | array of object | |
|
Beskrivning av processsteg
|
processSteps.description | string |
En kort beskrivning som förklarar processsteget |
|
SLA-varaktighet (hrs)
|
processSteps.duration | string |
SLA-varaktigheten i timmar. Ange värdet 0 om det inte är tillämpligt |
|
Är första steget
|
processSteps.firstStep | boolean |
Ange om posten Processsteg är det första steget i affärsprocessen |
|
Steginstruktioner
|
processSteps.instructions | string |
Instruktioner till ansvarig användare under steg |
|
Processstegnyckel
|
processSteps.key | string |
En unik nyckel för att identifiera processsteget |
|
Namn på processsteg
|
processSteps.name | string |
Ett kort namn för processsteget |
|
Processtadium
|
processSteps.processStage | string |
En nyckel som definierar processsteget i det aktuella steget |
|
Referens-URL för processsteg
|
processSteps.referenceUrl | string |
En referens-URL för processsteget |
|
Ansvarstyp
|
processSteps.responsibility | string |
Användar-/rollbaserat ansvar |
|
Ansvarig roll för processsteg
|
processSteps.responsibleRole | string |
Rollen som ansvarar för det aktuella steget |
|
roleLevels
|
processSteps.roleLevels | array of string |
Villkorsstyrda rollnivåer |
|
stepOptions
|
processSteps.stepOptions | array of object | |
|
Beskrivning av stegalternativ
|
processSteps.stepOptions.description | string |
En kort beskrivning som förklarar stegalternativet |
|
Namn på stegalternativ
|
processSteps.stepOptions.name | string |
Ett kort namn för stegalternativet |
|
Nästa steg
|
processSteps.stepOptions.nextStep | string |
Nästa steg som affärsprocessen dirigeras till. Lämna tomt om inga ytterligare steg |
|
Stegalternativanteckningar
|
processSteps.stepOptions.notes | string |
Valfritt alternativ för anteckningar för steg |
|
visibleObjects
|
processSteps.stepOptions.visibleObjects | array of object | |
|
Objekt-ID för stegalternativ
|
processSteps.stepOptions.visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
processSteps.stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
processSteps.stepOptions.visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
processSteps.stepOptions.visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
processSteps.stepOptions.visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
processSteps.stepOptions.visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är stegalternativobjekt redigerbart
|
processSteps.stepOptions.visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är stegalternativobjekt obligatoriskt
|
processSteps.stepOptions.visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
|
visibleObjects
|
processSteps.visibleObjects | array of object | |
|
Objekt-ID för processsteg
|
processSteps.visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
processSteps.visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
processSteps.visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
processSteps.visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
processSteps.visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
processSteps.visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
processSteps.visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är processstegsobjektet redigerbart
|
processSteps.visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är processstegsobjekt obligatoriskt
|
processSteps.visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
|
Referens-URL för BPM-profil
|
referenceUrl | string |
En valfri URL som kan refereras till för den aktuella BPM-profilen |
GetBPMRecordState
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Beskrivning av processsteg
|
description | string |
En kort beskrivning som förklarar processsteget |
|
SLA-varaktighet (hrs)
|
duration | string |
SLA-varaktigheten i timmar. Ange värdet 0 om det inte är tillämpligt |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Namn på händelsestämpelhistorik
|
eventStampHistory.eventName | string |
Namn på händelsestämpeln |
|
Tidsstämpel för händelsestämpelhistorik
|
eventStampHistory.timeStamp | date-time |
Tidsstämpeln för när händelsestämpeln inträffade |
|
historia
|
history | array of object | |
|
Kommentarer om historik
|
history.comments | string |
Valfria kommentarer som lades till när posten Historik skapades |
|
Aktuell historikroll
|
history.currentRole | string |
Den aktuella rollen vid tidpunkten för posten Historik |
|
Aktuell historikanvändare
|
history.currentUser | string |
Den aktuella användaren vid tidpunkten för posten Historik |
|
Stegvaraktighet
|
history.duration | string |
Tiden (i minuter) posten fanns i det aktuella processsteget innan den åtgärdades |
|
Händelsestämpel för historik
|
history.eventStamp | array of string |
Händelsestämplar som inträffade vid tidpunkten för posten Historik |
|
Från steg
|
history.fromStep | string |
Nyckeln för processsteget som BPM-posten kom från vid tidpunkten för posten Historik |
|
Från stegnamn
|
history.fromStepName | string |
Namnet på processsteget som BPM-posten kom från vid tidpunkten för posten Historik |
|
Historikalternativ markerat
|
history.optionSelected | string |
Det alternativ som valts när BPM-posten ska användas |
|
BPM-processnyckel för historik
|
history.processKey | string |
Den unika BPM-processnyckeln för posten Historik |
|
Processsteg för historik
|
history.processStage | string |
Processsteget vid tidpunkten för posten Historik |
|
BPM-post-ID för historik
|
history.recordId | string |
Post-ID:t för den BPM-relaterade post som genererades under processen Registrera BPM-post |
|
Ansvarig roll för historik
|
history.responsibleRole | string |
Den ansvariga rollen för BPM-posten vid tidpunkten för posten Historik |
|
Historikansvariga användare
|
history.responsibleUsers | array of string |
Ansvarsfulla användare vid tidpunkten för posten Historik |
|
Datum för historiköverföring
|
history.submissionDate | date-time |
Datum/tid då BPM-posten åtgärdades |
|
Till processsteg
|
history.toProcessStage | string |
Processsteget för BPM-posten vid tidpunkten för posten Historik |
|
Till steg
|
history.toStep | string |
Nyckeln för processsteget för BPM-posten vid tidpunkten för posten Historik |
|
Till stegnamn
|
history.toStepName | string |
Namnet på processsteget för BPM-posten vid tidpunkten för posten Historik |
|
Steginstruktioner
|
instructions | string |
Instruktioner till ansvarig användare under steg |
|
Processstegnyckel
|
key | string |
En unik nyckel för att identifiera processsteget |
|
Namn på processsteg
|
name | string |
Ett kort namn för processsteget |
|
BPM-profilnyckel
|
processKey | string |
En unik nyckel för att identifiera BPM-profilen |
|
Processtadium
|
processStage | string |
En nyckel som definierar processsteget i det aktuella steget |
|
BPM-post-ID
|
recordId | string |
Post-ID:t som genereras av BPM-modulen när du registrerar en BPM-post |
|
BPM-postreferens
|
recordRef | string |
Ett läsbart nummer som genereras av BPM-modulen med hjälp av numreringsmodulen när du registrerar en BPM-post |
|
Referens-URL för processsteg
|
referenceUrl | string |
En referens-URL för processsteget |
|
Ansvarig roll för processsteg
|
responsibleRole | string |
Rollen som ansvarar för det aktuella steget |
|
Processstegsansvariga användare
|
responsibleUsers | array of string |
Ansvarsfulla användare för det aktuella processsteget |
|
roles
|
roles | array of object | |
|
Rollnamn
|
roles.name | string |
Namnet på rollen |
|
users
|
roles.users | array of object | |
|
E-post för roll
|
roles.users.email | string |
E-postadresser som är länkade till rollnamnet |
|
stepOptions
|
stepOptions | array of object | |
|
Beskrivning av stegalternativ
|
stepOptions.description | string |
En kort beskrivning som förklarar stegalternativet |
|
Händelsestämpel för stegalternativ
|
stepOptions.eventStamp | array of string |
En händelsestämpel för det aktuella stegalternativet |
|
Namn på stegalternativ
|
stepOptions.name | string |
Ett kort namn för stegalternativet |
|
Nästa steg
|
stepOptions.nextStep | string |
Nästa steg som affärsprocessen dirigeras till. Lämna tomt om inga ytterligare steg |
|
Stegalternativanteckningar
|
stepOptions.notes | string |
Valfritt alternativ för anteckningar för steg |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Objekt-ID för stegalternativ
|
stepOptions.visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
stepOptions.visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
stepOptions.visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är stegalternativobjekt redigerbart
|
stepOptions.visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är stegalternativobjekt obligatoriskt
|
stepOptions.visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
|
Skickat i steg
|
submittedIntoStep | date-time |
Datum/tid då BPM-posten skickades till det aktuella processsteget |
|
Varaktighet för måltid
|
targetTimeDuration | date-time |
Datum/tid som BPM-posten måste utföras baserat på SLA-varaktigheten |
|
visibleObjects
|
visibleObjects | array of object | |
|
Objekt-ID för processsteg
|
visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är processstegsobjektet redigerbart
|
visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är processstegsobjekt obligatoriskt
|
visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
KeywordValues
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Etikett
|
label | string | |
|
Värde
|
value | string |
RegisterBPMRecord
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Beskrivning av processsteg
|
description | string |
En kort beskrivning som förklarar processsteget |
|
SLA-varaktighet (hrs)
|
duration | string |
SLA-varaktigheten i timmar. Ange värdet 0 om det inte är tillämpligt |
|
eventStampHistory
|
eventStampHistory | array of object | |
|
Namn på händelsestämpelhistorik
|
eventStampHistory.eventName | string |
Namn på händelsestämpeln |
|
Tidsstämpel för händelsestämpelhistorik
|
eventStampHistory.timeStamp | date-time |
Tidsstämpeln för när händelsestämpeln inträffade |
|
historia
|
history | array of object | |
|
Kommentarer om historik
|
history.comments | string |
Valfria kommentarer som lades till när posten Historik skapades |
|
Aktuell historikroll
|
history.currentRole | string |
Den aktuella rollen vid tidpunkten för posten Historik |
|
Aktuell historikanvändare
|
history.currentUser | string |
Den aktuella användaren vid tidpunkten för posten Historik |
|
Stegvaraktighet
|
history.duration | string |
Tiden (i minuter) posten fanns i det aktuella processsteget innan den åtgärdades |
|
Händelsestämpel för historik
|
history.eventStamp | array of string |
Händelsestämplar som inträffade vid tidpunkten för posten Historik |
|
Från steg
|
history.fromStep | string |
Nyckeln för processsteget som BPM-posten kom från vid tidpunkten för posten Historik |
|
Från stegnamn
|
history.fromStepName | string |
Namnet på processsteget som BPM-posten kom från vid tidpunkten för posten Historik |
|
Historikalternativ markerat
|
history.optionSelected | string |
Det alternativ som valts när BPM-posten ska användas |
|
BPM-processnyckel för historik
|
history.processKey | string |
Den unika BPM-processnyckeln för posten Historik |
|
Processsteg för historik
|
history.processStage | string |
Processsteget vid tidpunkten för posten Historik |
|
BPM-post-ID för historik
|
history.recordId | string |
Post-ID:t för den BPM-relaterade post som genererades under processen Registrera BPM-post |
|
Ansvarig roll för historik
|
history.responsibleRole | string |
Den ansvariga rollen för BPM-posten vid tidpunkten för posten Historik |
|
Historikansvariga användare
|
history.responsibleUsers | array of string |
Ansvarsfulla användare vid tidpunkten för posten Historik |
|
Datum för historiköverföring
|
history.submissionDate | date-time |
Datum/tid då BPM-posten åtgärdades |
|
Till processsteg
|
history.toProcessStage | string |
Processsteget för BPM-posten vid tidpunkten för posten Historik |
|
Till steg
|
history.toStep | string |
Nyckeln för processsteget för BPM-posten vid tidpunkten för posten Historik |
|
Till stegnamn
|
history.toStepName | string |
Namnet på processsteget för BPM-posten vid tidpunkten för posten Historik |
|
Steginstruktioner
|
instructions | string |
Instruktioner till ansvarig användare under steg |
|
Processstegnyckel
|
key | string |
En unik nyckel för att identifiera processsteget |
|
Namn på processsteg
|
name | string |
Ett kort namn för processsteget |
|
BPM-profilnyckel
|
processKey | string |
En unik nyckel för att identifiera BPM-profilen |
|
Processtadium
|
processStage | string |
En nyckel som definierar processsteget i det aktuella steget |
|
BPM-post-ID
|
recordId | string |
Post-ID:t som genereras av BPM-modulen när du registrerar en BPM-post |
|
BPM-postreferens
|
recordRef | string |
Ett läsbart nummer som genereras av BPM-modulen med hjälp av numreringsmodulen när du registrerar en BPM-post |
|
Referens-URL för processsteg
|
referenceUrl | string |
En referens-URL för processsteget |
|
Ansvarig roll för processsteg
|
responsibleRole | string |
Rollen som ansvarar för det aktuella processsteget |
|
Processstegsansvariga användare
|
responsibleUsers | array of string |
De användare som ansvarar för det aktuella processsteget |
|
roles
|
roles | array of object | |
|
Rollnamn
|
roles.name | string |
Namnet på rollen |
|
users
|
roles.users | array of object | |
|
E-post för roll
|
roles.users.email | string |
E-postadresser som är länkade till rollnamnet |
|
stepOptions
|
stepOptions | array of object | |
|
Beskrivning av stegalternativ
|
stepOptions.description | string |
En kort beskrivning som förklarar stegalternativet |
|
Händelsestämpel för stegalternativ
|
stepOptions.eventStamp | array of string |
En händelsestämpel för det aktuella stegalternativet |
|
Namn på stegalternativ
|
stepOptions.name | string |
Ett kort namn för stegalternativet |
|
Nästa steg
|
stepOptions.nextStep | string |
Nästa steg som affärsprocessen dirigeras till. Lämna tomt om inga ytterligare steg |
|
Stegalternativanteckningar
|
stepOptions.notes | string |
Valfria anteckningar för stegalternativet |
|
visibleObjects
|
stepOptions.visibleObjects | array of object | |
|
Objekt-ID för stegalternativ
|
stepOptions.visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
stepOptions.visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
stepOptions.visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
stepOptions.visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
stepOptions.visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
stepOptions.visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
stepOptions.visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är stegalternativobjekt redigerbart
|
stepOptions.visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är stegalternativobjekt obligatoriskt
|
stepOptions.visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
|
visibleObjects
|
visibleObjects | array of object | |
|
Objekt-ID för processsteg
|
visibleObjects.id | string |
ID:t för komponenten som refereras till i användargränssnittet |
|
Val
|
visibleObjects.inputOptions.choices | array of object | |
|
Typetikett för alternativ
|
visibleObjects.inputOptions.choices.label | string |
En etikett för valt val |
|
Valtypsvärde
|
visibleObjects.inputOptions.choices.value | string |
Ett värde för valt val |
|
Etikett för indataalternativ
|
visibleObjects.inputOptions.label | string |
En etikett som definierar indatafältet eller den redigerbara komponenten |
|
Meddelanden om indataalternativ
|
visibleObjects.inputOptions.messages | array of string |
Meddelanden som ska användas när valideringen av indataalternativ misslyckas |
|
Typ av indataalternativ
|
visibleObjects.inputOptions.type | string |
Definierar vilken typ av indatafält eller redigerbar komponent som ska användas |
|
Är processstegsobjektet redigerbart
|
visibleObjects.isEditable | boolean |
Är komponenten refererad redigerbar för användarindata |
|
Är processstegsobjekt obligatoriskt
|
visibleObjects.isMandatory | boolean |
Kräver den komponent som refereras användarindata |
StdJSONResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Result
|
result | string |
Result |
objekt
Detta är typen 'objekt'.