Lex Power Sign (förhandsversion)
Lex Persona är en europeisk leverantör av kvalificerade förtroendetjänster som erbjuder en rad lösningar för elektroniska signaturer. Med Lex Enterprise har du åtkomst till alla eIDAS-signaturnivåer, tillsammans med ett stort antal autentiseringsmetoder för undertecknare. Dina signaturböcker är inbäddade i digitala arbetsflöden. Automatisera anslutningar mellan Lex Enterprise och alla dina verktyg för att eliminera repetitiva uppgifter, få effektivitet och påskynda verksamheten.
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 | Lex Persona-support |
| URL | https://support.lex-persona.com |
| E-postmeddelande | support@lex-persona.com |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | Lex Persona |
| Webbplats | https://www.lex-persona.com |
| Sekretesspolicy | https://www.lex-persona.com/politique-de-confidentialite/ |
| Kategorier | Artificiell intelligens; Webbplats |
Lex Persona är en europeisk leverantör av kvalificerade förtroendetjänster som erbjuder en rad lösningar för elektroniska signaturer. Med den här anslutningsappen kan du enkelt lägga till funktionen för elektronisk signatur i ditt Microsoft-baserade program (PowerApp, .NET-baserad webbapp, Dynamics...) och miljö (Outlook, Sharepoint, Teams...). Anslutningsappen backas upp av vår Lex Enterprise Workflow Manager. Du kan skapa arbetsflöden för elektroncsignatur som består av olika typer av steg som kan köras i sekvens och/eller parallellt. Anslutningsappen stöder alla eIDAS-signaturnivåer och erbjuder ett brett utbud av autentiseringsmetoder för undertecknare (OTP, SSO, France Connect, Identité Numérique La Poste, maskinvarutoken...)
Förutsättningar
Du måste ha följande för att kunna fortsätta:
- Lex Enterprise-prenumeration. Använd utvärderingsplanen för att testa
Miljökraven är:
- En Microsoft Power Apps- eller Power Automate-plan med anpassad anslutningsfunktion
- Power Platform CLI-verktygen
Hämta autentiseringsuppgifter
Kontakta våra säljare på commercial@lex-persona.com för att få en Lex Enteprise-prenumeration eller ett konto i våra utvärderingssystem.
Anslut till Lex Enterprise-portalen med ditt konto och generera en API-nyckel.
Kom igång med anslutningsappen
Skapa först en anslutning för anslutningsappen. Ange autentiseringsmetoden till API-nyckel, ange DIN API-nyckel ("Bearer act_XXXXXXX") och ange att API-nyckeln måste placeras i Autrorization-huvudet för API-anropen.
Stegen för att skapa ett enkelt signaturarbetsflöde är följande:
- direkt efter tigern hämtar du det anslutna Lex Enterprise-användar-ID:t (det här ID:t krävs för att skapa ett arbetsflöde) med åtgärden Hämta mig
- sökmedgivandesidor med sidorna för sökmedgivande action_. Du kan använda textparametern för att söka efter medgivandesidor efter namn (medgivandesidor definierar signaturnivån och är förkonfigurerade i din Lex Enterprise-miljö)
- skapa ett signaturarbetsflöde med åtgärden Skapa arbetsflöde . I det här steget måste du ange undertecknarnas information.
- söksignaturprofiler med åtgärden Sök signaturprofiler. Du kan använda textparametern för att söka efter signaturprofiler efter namn (signaturprofiler styr vissa aspekter av beteendet för medgivandesidor. Tvinga undertecknaren att rulla längst ned i dokumentet innan du till exempel signerar)
- Hämta ett dokument från din miljö (Sharepoint, Outlook, OneDrive...)
- lägg till dokumentet i arbetsflödet med åtgärden Skapa del och ange parametern createDocument till true
- starta arbetsflödet med åtgärden Uppdatera arbetsflöde och ange arbetsflödesstatusen till startad
Observera: Anslutningsappen är som standard kopplad till vår utvärderingsserver. Om du vill koppla anslutningsappen till din egen klientorganisation måste du ändra värd-URL:en i säkerhetsdefinitionen för anslutningsappen eller i apiDefinitions.json-filen:
- "host": "yourtenant.lexpersona.com",
Känna till problem och begränsningar
Åtgärden Skapa dokument accepterar en lista över dokumentdelar i nyttolasten. Men om du anger flera delar kommer endast den första att beaktas (detta beror på en bugg i vårt API. Den kommer att åtgärdas i nästa version av anslutningsappen).
Om du vill lägga till flera dokument i ett arbetsflöde är det därför nödvändigt att utföra ett anrop till Skapa del med parametern createDocument inställd på true för varje dokument.
Vanliga fel och åtgärder
Om ett API-anrop misslyckas innehåller API-anropssvaret ett omfattande felmeddelande som visas i anslutningsappens körningshistorik. Meddelandet innehåller även ett logg-ID, så om du behöver mer information om felet kan du ansluta till Lex Enteprise-portalen och läsa serverloggfilen. Alternativley, du kan ställa in en Postman-begäran för att söka i våra servrar loggar (plase läs dokumentationen: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
De vanligaste HTTP-felkoderna som returneras av vårt API är följande:
- Fel 400 – Felaktig begäran. Det är något fel i din begäran paylod. I loggen hittar du information om orsaken till felet
- Fel 401 – Obehörig. Du har inte behörighet att utföra den här åtgärden. Kontrollera åtkomstbehörigheten för Lex Persona-användare
- Fel 403 – Förbjudet. DIN API-nyckel är invlaid eller inaktiverad
- Fel 404 – Hittades inte. Det finns ett fel i begärande-URL:en
Du kan också läsa vår dokumentation för mer information om varje API-anrop möjliga felkoder (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
Vanliga frågor
Vilka dokumentformat stöds av anslutningsappen?
Dokumenten som du kan skicka för signatur kan ha formaten pdf, docx, pptx och xlsx. Anslutningsappen konverterar dokumenten till pdf om det behövs och signaturerna har PAdES-format.
Det går också att signera XML-dokument. I det här fallet tillämpas ingen konvertering och signaturerna har XAdES-formatet.
Det går också att ladda upp zip-filer. Anslutningsappen packar upp arkivet och lägger till varje dokument i arbetsflödet.
Du kan också lägga till bifogade filer i arbetsflöden för signaturer. Den bifogade filen är inte signerad och kan ha valfritt format.
Kan ett dokument ha flera undertecknare
Ja. Antalet undertecknare av ett dokument är obegränsat.
Är det möjligt att signera flera dokument samtidigt
Ja. Du kan lägga till flera dokument i ett arbetsflöde och alla dokument signeras samtidigt. Observera dock att i det här fallet kommer uppsättningen dokument att vara juridically länkade och att systemet kommer att producera en unik bevisfil.
Du kan också skapa mutlpiple workglows coantaining samma undertecknare. Vid signaturen visas listan över dokument för undertecknaren och undertecknaren får möjlighet att välja de dokument som hon vill signera. I det här fallet kommer dokumenten att vara juridically oberoende, ans ans en bevisfil kommer att skapas för varje dokument.
Är det möjligt att signera ett dokument offline
Nej. En intenet-anslutning krävs för att få åtkomst till medgivandesidorna.
Är det möjligt att skicka automatisk signatur remiders till undertecknare
Ja. Du kan konfigurera påminnelseperioden och det maximala antalet påminnelser som ska skickas.
Är det möjligt att ändra ett redan startat signaturarbetsflöde
Ja. Innan någon signatur kan du ändra något i arbetsflödet. Efter den första signaturen är det omöjligt att ändra dokumenten, men du kan fortfarande ändra arbetsflödesstegen.
Vad är giltighetsvaraktigheten för engångslösenorden
Giltighetstiden för engångslösenord är två minuter (en countdow visas på medgivandesidorna).
Är det möjligt att verifiera en giltighet för elektroniska signaturer
Du kan använda fönstret Signaturer i Adobe Acrobat för att kontrollera giltigheten för signaturerna i ett pdf-dokument. Du kan också använda en webbtjänst för betrodd signaturverifiering (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation till exempel)
Vilka är lagringsvillkoren för Lex Persona-dokument
Som standard behåller vi dokumenten ans evidences-filer på våra servrar. Tou kan när som helst söka efter och ladda ned dokument. Om det begärs kan vi dock priodiskt ta bort dina dokument från våra servrar.
Behåller Lex Persona tidsstämplar tokens
Nej. Vi behåller inte tidsstämplar. Om det behövs kan du extracxt dessa token från de signerade dokumenten.
Finns det en uttagsperiod för ett signerat dokument
Ja. Tillbakadragandet beror på de juridiska villkor som gäller för dokumentet.
Är det möjligt att avbryta ett signaturarbetsflöde
Ja. En authoriezd-användare kan när som helst avbryta ett arbetsflöde för påbörjad signatur. Ingen evicences-fil skapas och om dokumentet redan har signerats av en eller flera undertecknare kommer gnagarna att ogiltigförklaras.
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Namn | Typ | Description | Krävs |
|---|---|---|---|
| API-nyckel | securestring | API-nyckeln för det här API:et | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Hämta arbetsflöde |
Hämta arbetsflöde från arbetsflödes-ID |
| Hämta dokument |
Hämta ett dokument |
| Hämta kontakt |
Hämta kontaktinformation från kontakt-ID |
| Hämta metadatalayout |
Hämta en arbetsflödeslayout |
| Hämta metadatamappning |
Hämta metadatamappningen för den angivna klientorganisationen |
| Hämta mig |
Hämta det anslutna användar-ID:t |
| Hämta signaturprofil |
Hämta en signaturprofil |
| Hämta url för constent-sida |
Skapa och hämta url:en för medgivandesidan för en mottagare |
| Ladda ned bevisfil |
Ladda ned bevisfilen för arbetsflödet |
| Ladda ned ett arbetsflödesdokument |
Ladda ned arbetsflödesdokumenten |
| Sidan Hämta medgivande |
Hämta information om medgivandesidan från medgivandesidans ID |
| Sidor med sökmedgivande |
Sidor med sökmedgivande |
| Skapa arbetsflöde |
Skapa ett arbetsflöde |
| Skapa dokument |
Skapa ett dokument från färdiga delar |
| Skapa en del |
Skapa en dokumentdel |
| Skapa kontakt |
Lägga till en kontakt i den aktuella användarens kontaktlista |
| Skapa metadatalayout |
Skapa en metadatalayout |
| Skapa signaturprofil |
Skapa en signaturprofil |
| Sök efter metadatalayouter |
Sök arbetsflödeslayouter |
| Sök i arbetsflöden |
Sök i arbetsflöden |
| Sök i dokument |
Sök i dokument |
| Sök kontakter |
Sök kontakter |
| Sök signaturprofiler |
Sök signaturprofiler |
| Ta bort arbetsflöde |
Ta bort ett arbetsflöde |
| Ta bort dokument |
Ta bort ett dokument |
| Ta bort kontakt |
Ta bort kontakt från den aktuella användarens samtidiga lista |
| Uppdatera arbetsflöde |
Uppdatera ett arbetsflöde |
| Uppdatera dokument |
Uppdatera ett dokument |
| Uppdatera kontakt |
Ändra en befintlig kontaktinformation |
| Uppdatera metadatalayout |
Uppdatera en metadatalayout |
| Uppdatera signaturprofil |
Uppdatera en signaturprofil |
Hämta arbetsflöde
Hämta arbetsflöde från arbetsflödes-ID
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för arbetsflödet |
Returer
- Body
- workflow
Hämta dokument
Hämta ett dokument
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
ID för dokumentet |
Returer
- Body
- document
Hämta kontakt
Hämta kontaktinformation från kontakt-ID
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kontakt Id
|
contactId | True | string |
ID för kontakten |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
Returer
- Body
- contact
Hämta metadatalayout
Hämta en arbetsflödeslayout
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Layout-ID
|
layoutId | True | string |
ID för layouten |
Returer
Metadatalayout
- Body
- layout
Hämta metadatamappning
Hämta metadatamappningen för den angivna klientorganisationen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Hyresgäst-ID
|
tenantId | True | string |
ID för klientorganisationen |
Returer
- Body
- dataMapping
Hämta mig
Hämta signaturprofil
Hämta en signaturprofil
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Signaturprofil-ID
|
spId | True | string |
ID för signaturprofilen |
Returer
- Body
- signatureProfile
Hämta url för constent-sida
Skapa och hämta url:en för medgivandesidan för en mottagare
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för arbetsflödet |
|
E-postmottagare
|
recipientEmail | string |
E-post till den berörda mottagaren |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Url:en för medgivandesidan för den berörda mottagaren
|
inviteUrl | string |
Url:en för medgivandesidan för den berörda mottagaren |
Ladda ned bevisfil
Ladda ned bevisfilen för arbetsflödet
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för arbetsflödet |
|
Godkänn
|
Accept | True | string |
Godkänn |
Returer
- response
- binary
Ladda ned ett arbetsflödesdokument
Ladda ned arbetsflödesdokumenten
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för arbetsflödet |
Returer
- response
- binary
Sidan Hämta medgivande
Hämta information om medgivandesidan från medgivandesidans ID
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sid-ID för medgivande
|
cpId | True | string |
ID för medgivandesidan |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
Returer
- Body
- consentPage
Sidor med sökmedgivande
Sidor med sökmedgivande
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Söktext
|
text | string |
Söktext |
|
|
Sök som standard
|
items.isDefault | string |
Sök efter standardsidan för medgivande |
|
|
Sökning har inaktiverats
|
items.isDisabled | string |
Sök efter sidor med inaktiverat medgivande |
|
|
Söknamn
|
items.name | string |
Sök efter namn på medgivandesida |
|
|
Sökstegstyp
|
items.stepType | string |
Sök efter stegtyp |
|
|
Sök klient-ID
|
items.clientId | string |
Sök efter klient-ID |
|
|
Datum då sökningen skapades
|
items.created | string |
Sök efter skapandedatum |
|
|
Sökuppdateringsdatum
|
items.updated | string |
Sök efter senaste uppdateringsdatum |
|
|
Sortera efter
|
sortBy | string |
Fältet som sökresultatet ska sorteras på |
|
|
Sorteringsordning
|
sortOrder | string |
Sorteringsriktningen |
|
|
Objekt per sida
|
itemsPerPage | string |
Antal objekt per sida i svaret |
|
|
Sidindex
|
pageIndex | string |
Index för den returnerade sidan |
Returer
- Body
- consentPages
Skapa arbetsflöde
Skapa ett arbetsflöde
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
userId | True | string |
Användar-ID för arbetsflödets ägare |
|
Innehållstyp
|
Content-Type | string |
Innehållstyp |
|
|
Namn
|
name | True | string |
Namnet på arbetsflödet |
|
Description
|
description | string |
Beskrivning av arbetsflödet |
|
|
Id-nummer
|
id | string |
steg-ID |
|
|
stepType
|
stepType | string |
signatur eller godkännande |
|
|
consentPageId
|
consentPageId | True | string |
ID för den medgivandesida (signaturnivå) som är associerad med den här mottagaren |
|
Mejladress
|
True | string |
mottagarens e-post |
|
|
userId
|
userId | string |
referera till en LE-användare i stället för att skapa en mottagare i farten |
|
|
telefonnummer
|
phoneNumber | string |
reicpients mobiltelefonnummer |
|
|
förnamn
|
firstName | string |
mottagarens förnamn |
|
|
efternamn
|
lastName | string |
mottagarens efternamn |
|
|
country
|
country | string |
mottagarens landskod |
|
|
preferredLocale
|
preferredLocale | string |
mottagarens språkkod |
|
|
organizationId
|
organizationId | string |
ID för mottagarens LE-organisation |
|
|
requiredRecipients
|
requiredRecipients | number |
minsta antal undertecknare som måste signera för att ta nästa steg |
|
|
validityPeriod
|
validityPeriod | number |
varaktighet för stegets giltighet |
|
|
inviteperiod
|
inviteperiod | number |
frekvens för signaturpåminnelser |
|
|
maxInvites
|
maxInvites | number |
maximalt antal signaturpåminnelser |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
styr leveransen av det signerade dokumentet till undertecknare |
|
|
allowComments
|
allowComments | boolean |
tillåter/förbjuder kommentarer i det här steget |
|
|
hideAttachments
|
hideAttachments | boolean |
styr visningen av bifogade filer till undertecknare |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
styr visningen av andra undertecknare till undertecknaren |
|
|
Aviserade händelser
|
notifiedEvents | array of string |
Aviserade arbetsflödeshändelser |
|
|
userId
|
userId | string |
Bevakarens användar-ID |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Arbetsflödeshändelser som meddelas till den här bevakaren |
|
|
Mejladress
|
string |
Bevakarens e-post |
||
|
Mall-ID
|
templateId | string |
ID för mallen som arbetsflödet härleds från |
|
|
Layout-ID
|
layoutId | string |
Metadatalayout som används av arbetsrutan |
|
|
data1
|
data1 | string |
Första metadata |
|
|
data2
|
data2 | string |
Andra metadata |
|
|
data3
|
data3 | string |
Tredje metadata |
|
|
data4
|
data4 | string |
Fjärde metadata |
|
|
data5
|
data5 | string |
Femte metadata |
|
|
data6
|
data6 | string |
Sjätte metadata |
|
|
data7
|
data7 | string |
Sjunde metadata |
|
|
data8
|
data8 | string |
Heighth-metadata |
Returer
- Body
- workflow
Skapa dokument
Skapa ett dokument från färdiga delar
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för det berörda arbetsflödet |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
innehållstyp
|
contentType | string |
innehållstyp |
|
|
filename
|
filename | string |
filename |
|
|
hasch
|
hash | string |
hasch |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
Signaturprofilen för det här dokumentet |
Returer
- Body
- document
Skapa en del
Skapa en dokumentdel
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för det berörda arbetsflödet |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
Cotent-borttagning
|
Content-Disposition | True | string |
Content-Dispotion |
|
Skapa dokument
|
createDocuments | string |
Skapa ett dokument från den här delen |
|
|
Ignorera bifogade filer
|
ignoreAttachments | string |
Bifogade filer ignoreras |
|
|
Signaturprofil-ID
|
signatureProfileId | string |
Del som betraktas som en bifogad fil om den utelämnas |
|
|
Packa upp
|
unzip | string |
Packa upp filer |
|
|
Pdf till PdfA
|
pdf2pdfa | string |
Konvertera pdf till pdf/A |
|
|
Dokument
|
document | True | binary |
Uppladdade fildata |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Dokument
|
documents | array of document |
Dokument skapades |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
delar
|
parts | array of part |
delar |
Skapa kontakt
Lägga till en kontakt i den aktuella användarens kontaktlista
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
userId | True | string |
Användare som kontakten tillhör |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
Kontakta e-post
|
True | string |
Kontakta e-post |
|
|
Contatct-telefonnummer
|
phoneNumber | string |
telefonnummer |
|
|
Kontakta förnamn
|
firstName | True | string |
förnamn |
|
Kontakt efternamn
|
lastName | True | string |
efternamn |
|
Kontaktland
|
country | string |
country |
Returer
- Body
- contact
Skapa metadatalayout
Skapa en metadatalayout
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Hyresgäst-ID
|
tenantId | True | string |
ID för layouten |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
Namn
|
name | True | string |
Layoutnamnet |
|
Är inaktiverad
|
isDisabled | boolean |
Om värdet är true inaktiveras layouten |
|
|
springa
|
slot | string |
Metadataobjekt (data1 till data8) |
|
|
default
|
default | string |
Standardvärde för metadata i den här layouten |
|
|
optional
|
optional | boolean |
Om sant är det inte obligatoriskt att ange ett värde |
|
|
ReadOnly
|
readonly | boolean |
Dessutom kan värdet åsidosättas |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Om värdet är inställt på sant bevaras värdet mellan arbetsflöden |
Returer
Metadatalayout
- Body
- layout
Skapa signaturprofil
Skapa en signaturprofil
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Hyresgäst-ID
|
tenantId | True | string |
ID för klientorganisationen |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
Är standard
|
isDefault | True | string |
Gör den här signaturprofilen till standardprofil |
|
Är inaktiverad
|
isDisabled | string |
Inaktivera den här signaturprofilen |
|
|
Namn
|
name | True | string |
Namn på signaturprofil |
|
Dokumenttyp
|
documentType | True | string |
pdf, xml, word, excel, powerpoint, övrigt |
|
Signaturtyp
|
signatureType | True | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
Framtvinga att rulla längst ned i dokumentet
|
forceScrollDocument | True | boolean |
Tvinga undertecknaren att rulla längst ned i dokumentet |
|
Synligt signaturläge
|
pdfVisibleSignatureMode | string |
Synligt signaturläge (tillåtet, inaktiverat, noImage) |
|
|
Signaturtext
|
pdfSignatureImageText | string |
Text som visas i signaturer |
|
|
Signaturtextfärg
|
pdfSignatureImageTextColor | string |
Färgen på texten som visas i singatures pads |
|
|
Textstorlek för signatur
|
pdfSignatureImageTextSize | number |
Storleken på texten som visas i singatures pads |
Returer
- Body
- signatureProfile
Sök efter metadatalayouter
Sök arbetsflödeslayouter
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Söktext
|
text | string |
Söktext |
|
|
Sökning har inaktiverats
|
items.isDisabled | string |
Sök efter inaktiverade layouter |
|
|
Söknamn
|
items.name | string |
Sök efter layoutnamn |
|
|
Sök metadata
|
items.dataConfigurations.slot | string |
Sök efter förekomst av metadata |
|
|
Datum då sökningen skapades
|
items.created | string |
Sök efter skapandedatum |
|
|
Sökuppdateringsdatum
|
items.updated | string |
Sök efter senaste uppdateringsdatum |
|
|
Sortera efter
|
sortBy | string |
Fältet som används för att sortera sökresultatet |
|
|
Sorteringsordning
|
sortOrder | string |
Sorteringsriktningen |
|
|
Objekt per sida
|
itemsPerPage | string |
Antal objekt per sida i svaret |
|
|
Sidindex
|
pageIndex | string |
Index för den returnerade sidan |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | layouts |
Sök i arbetsflöden
Sök i arbetsflöden
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Godkänn
|
Accept | string |
Godkänn |
|
|
Söktext
|
text | string |
Söktext |
|
|
Sök efter metadatalayout
|
items.layoutId | string |
Sök efter metadatalayout |
|
|
Sökmall
|
items.templateId | string |
Sök efter arbetsflödesmall |
|
|
Sökgrupp
|
items.groupId | string |
Sök efter användargrupp |
|
|
Sökanvändare
|
items.userId | string |
Sök efter ägare |
|
|
Sök efter e-post
|
items.email | string |
Sök efter ägarens e-post |
|
|
Sök efter förnamn
|
items.firstname | string |
Sök efter ägarens förnamn |
|
|
Sök efternamn
|
items.lastname | string |
Sök efter ägarens efternamn |
|
|
Sökstatus
|
items.workflowStatus | string |
Sök efter arbetsflödesstatus |
|
|
Sök metadata 1
|
items.data1 | string |
Sök efter värde för metadata 1 |
|
|
Sök metadata 2
|
items.data2 | string |
Sök efter värde för metadata 2 |
|
|
Sök metadata 3
|
items.data3 | string |
Sök efter värde för metadata 3 |
|
|
Sök metadata 4
|
items.data4 | string |
Sök efter värde för metadata 4 |
|
|
Sök metadata 5
|
items.data5 | string |
Sök efter värde för metadata 5 |
|
|
Sök metadata 6
|
items.data6 | string |
Sök efter värde för metadata 6 |
|
|
Sök metadata 7
|
items.data7 | string |
Sök efter värde för metadata 7 |
|
|
Sök metadata 8
|
items.data8 | string |
Sök efter värde för metadata 8 |
|
|
Datum då sökningen skapades
|
items.created | string |
Sök efter skapandedatum |
|
|
Sökuppdateringsdatum
|
items.updated | string |
Sök efter senaste uppdateringsdatum |
|
|
Sökstartdatum
|
items.started | string |
Sök efter startdatum |
|
|
Sortera efter
|
sortBy | string |
Fältet som används för att sortera sökresultatet |
|
|
Sorteringsordning
|
sortOrder | string |
Sorteringsriktningen |
|
|
Objekt per sida
|
itemsPerPage | string |
Antal objekt per sida i svaret |
|
|
Sidindex
|
pageIndex | string |
Index för den returnerade sidan |
Returer
- Body
- workflows
Sök i dokument
Sök i dokument
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Söktext
|
text | string |
Söktext |
|
|
Sök efter metadatalayout
|
items.layoutId | string |
Sök efter metadatalayout |
|
|
Sökgrupp
|
items.groupId | string |
Sök efter användargrupp |
|
|
Sökanvändare
|
items.userId | string |
Sök efter ägare |
|
|
Sök arbetsflödes-ID
|
items.workflowId | string |
Sök efter arbetsflödes-ID |
|
|
Namn på sökarbetsflöde
|
items.workflowName | string |
Sök efter arbetsflödesnamn |
|
|
Sök metadata 1
|
items.data1 | string |
Sök efter värde för metadata 1 |
|
|
Sök metadata 2
|
items.data2 | string |
Sök efter värde för metadata 2 |
|
|
Sök metadata 3
|
items.data3 | string |
Sök efter värde för metadata 3 |
|
|
Sök metadata 4
|
items.data4 | string |
Sök efter värde för metadata 4 |
|
|
Sök metadata 5
|
items.data5 | string |
Sök efter värde för metadata 5 |
|
|
Sök metadata 6
|
items.data6 | string |
Sök efter värde för metadata 6 |
|
|
Sök metadata 7
|
items.data7 | string |
Sök efter värde för metadata 7 |
|
|
Sök metadata 8
|
items.data8 | string |
Sök efter värde för metadata 8 |
|
|
Sök signaturprofil
|
items.signatureProfileId | string |
Sök efter signaturprofil |
|
|
Datum då sökningen skapades
|
items.created | string |
Sök efter skapandedatum |
|
|
Sökuppdateringsdatum
|
items.updated | string |
Sök efter senaste uppdateringsdatum |
|
|
Sortera efter
|
sortBy | string |
Fältet som används för att sortera sökresultatet |
|
|
Sorteringsordning
|
sortOrder | string |
Sorteringsriktningen |
|
|
Objekt per sida
|
itemsPerPage | string |
Antal objekt per sida i svaret |
|
|
Sidindex
|
pageIndex | string |
Index för den returnerade sidan |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | documents |
Sök kontakter
Sök kontakter
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Söktext
|
text | string |
Sök efter text |
|
|
Sök efter e-post
|
items.email | string |
Sök via e-post |
|
|
Sök telefonnummer
|
items.phoneNumber | string |
Sök efter telefonnummer |
|
|
Sök efter förnamn
|
items.fisrtName | string |
Sök efter förnamn |
|
|
Sök efternamn
|
items.lastName | string |
Sök efter efternamn |
|
|
Sökland
|
items.country | string |
Sök efter land |
|
|
Objekt per sida
|
itemsPerPage | number |
Antal objekt per sida i svaret |
|
|
Sidindex
|
pageIndex | number |
Index för den returnerade sidan |
Returer
- Body
- contacts
Sök signaturprofiler
Sök signaturprofiler
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Söktext
|
text | string |
Söktext |
|
|
Sök som standard
|
items.isDefault | string |
Sök efter standardsignaturprofiler |
|
|
Sökning har inaktiverats
|
items.isDisabled | string |
Sök efter inaktiverade signaturprofiler |
|
|
Söknamn
|
items.name | string |
Sök efter namn på signaturprofil |
|
|
Sökdokument. skriv
|
items.documentType | string |
Sök efter dokumenttyp |
|
|
Söksignaturtyp
|
items.signatureType | string |
Sök efter signaturtyp |
|
|
Datum då sökningen skapades
|
items.created | string |
Sök efter skapandedatum |
|
|
Sökuppdateringsdatum
|
items.updated | string |
Sök efter senaste uppdateringsdatum |
|
|
Sortera efter
|
sortBy | string |
Fältet som används för att sortera sökresultatet |
|
|
Sorteringsordning
|
sortOrder | string |
Sorteringsriktningen |
|
|
Objekt per sida
|
itemsPerPage | string |
Antal objekt per sida i svaret |
|
|
Sidindex
|
pageIndex | string |
Index för den returnerade sidan |
Returer
- Body
- signatureProfiles
Ta bort arbetsflöde
Ta bort ett arbetsflöde
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för arbetsflödet som ska tas bort |
Returer
- Body
- workflow
Ta bort dokument
Ta bort ett dokument
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
ID för dokumentet |
Returer
- Body
- document
Ta bort kontakt
Ta bort kontakt från den aktuella användarens samtidiga lista
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kontakt Id
|
contactId | True | string |
ID för kontakten |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
Returer
- Body
- contact
Uppdatera arbetsflöde
Uppdatera ett arbetsflöde
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Arbetsflödes-ID
|
workflowId | True | string |
ID för arbetsflödet som ska uppdateras |
|
Innehållstyp
|
Content-Type | string |
Innehållstyp |
|
|
Användar-ID
|
userId | string |
ID för arbetsflödesägaren |
|
|
Namn
|
name | string |
Namnet på arbetsflödet |
|
|
Description
|
description | string |
Beskrivning av arbetsflödet |
|
|
Id-nummer
|
id | string |
steg-ID |
|
|
stepType
|
stepType | string |
signatur eller godkännande |
|
|
consentPageId
|
consentPageId | True | string |
ID för den medgivandesida (signaturnivå) som är associerad med den här mottagaren |
|
Mejladress
|
True | string |
mottagarens e-post |
|
|
userId
|
userId | string |
referera till en LE-användare i stället för att skapa en mottagare i farten |
|
|
telefonnummer
|
phoneNumber | string |
reicpients mobiltelefonnummer |
|
|
förnamn
|
firstName | string |
mottagarens förnamn |
|
|
efternamn
|
lastName | string |
mottagarens efternamn |
|
|
country
|
country | string |
mottagarens landskod |
|
|
preferredLocale
|
preferredLocale | string |
mottagarens språkkod |
|
|
organizationId
|
organizationId | string |
ID för mottagarens LE-organisation |
|
|
requiredRecipients
|
requiredRecipients | number |
minsta antal undertecknare som måste signera för att ta nästa steg |
|
|
validityPeriod
|
validityPeriod | number |
varaktighet för stegets giltighet |
|
|
inviteperiod
|
inviteperiod | number |
frekvens för signaturpåminnelser |
|
|
maxInvites
|
maxInvites | number |
maximalt antal signaturpåminnelser |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
styr leveransen av det signerade dokumentet till undertecknare |
|
|
allowComments
|
allowComments | boolean |
tillåter/förbjuder kommentarer i det här steget |
|
|
hideAttachments
|
hideAttachments | boolean |
styr visningen av bifogade filer till undertecknare |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
styr visningen av andra undertecknare till undertecknaren |
|
|
Aviserade händelser
|
notifiedEvents | array of string |
Aviserade arbetsflödeshändelser |
|
|
userId
|
userId | string |
Watcher-användar-ID |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Arbetsflödeshändelser som meddelas till den här bevakaren |
|
|
Mejladress
|
string |
Mejladress |
||
|
Arbetsflödesstatus
|
workflowStatus | string |
Aktuell status för arbetsflödet |
|
|
data1
|
data1 | string |
första metadata |
|
|
data2
|
data2 | string |
andra metadata |
|
|
data3
|
data3 | string |
tredje metadata |
|
|
data4
|
data4 | string |
fjärde metadata |
|
|
data5
|
data5 | string |
femte metadata |
|
|
data6
|
data6 | string |
sjätte metadata |
|
|
data7
|
data7 | string |
sjunde metadata |
|
|
data8
|
data8 | string |
heighth-metadata |
Returer
- Body
- workflow
Uppdatera dokument
Uppdatera ett dokument
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
documentId | True | string |
ID för dokumentet |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
signatureProfileId
|
signatureProfileId | string |
Signaturprofilen som ska bifogas i det här dokumentet |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Returer
- Body
- document
Uppdatera kontakt
Ändra en befintlig kontaktinformation
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kontakt Id
|
contactId | True | string |
ID för kontakten |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
E-post för kontakten
|
string |
E-post för kontakten |
||
|
Telefonnummer för kontakten
|
phoneNumber | string |
Telefonnummer för kontakten |
|
|
Kontaktens förnamn
|
firstName | string |
Kontaktens förnamn |
|
|
Kontaktens efternamn
|
lastName | string |
Kontaktens efternamn |
|
|
Kontaktens land
|
country | string |
Kontaktens land |
Returer
- Body
- contact
Uppdatera metadatalayout
Uppdatera en metadatalayout
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Hyresgäst-ID
|
layoutId | True | string |
ID för layouten |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
Namn
|
name | True | string |
Layoutnamnet |
|
Är inaktiverad
|
isDisabled | boolean |
Om värdet är true inaktiveras layouten |
|
|
springa
|
slot | string |
Metadataobjekt (data1 till data8) |
|
|
default
|
default | string |
Standardvärde för metadata i den här layouten |
|
|
optional
|
optional | boolean |
Om sant är det inte obligatoriskt att ange ett värde |
|
|
ReadOnly
|
readonly | boolean |
Dessutom kan värdet åsidosättas |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Om värdet är inställt på sant bevaras värdet mellan arbetsflöden |
Returer
Metadatalayout
- Body
- layout
Uppdatera signaturprofil
Uppdatera en signaturprofil
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Signaturprofil-ID
|
spId | True | string |
ID för signaturprofilen |
|
Innehållstyp
|
Content-Type | True | string |
Innehållstyp |
|
Är standard
|
isDefault | string |
Gör den här signaturprofilen till standardprofil |
|
|
Är inaktiverad
|
isDisabled | string |
Inaktivera den här signaturprofilen |
|
|
Namn
|
name | string |
Namn på signaturprofil |
|
|
Signaturtyp
|
signatureType | string |
pades,xades,xadesDetached,xadesDetachedManifest,cades,helios |
|
|
Framtvinga att rulla längst ned i dokumentet
|
forceScrollDocument | boolean |
Tvinga undertecknaren att rulla längst ned i dokumentet |
|
|
Synligt signaturläge
|
pdfVisibleSignatureMode | string |
Synligt signaturläge (tillåtet, inaktiverat, noImage) |
|
|
Signaturtext
|
pdfSignatureImageText | string |
Text som visas i signaturer |
|
|
Signaturtextfärg
|
pdfSignatureImageTextColor | string |
Färgen på texten som visas i singatures pads |
|
|
Textstorlek för signatur
|
pdfSignatureImageTextSize | number |
Storleken på texten som visas i singatures pads |
Returer
- Body
- signatureProfile
Definitioner
consentPage
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Tillåter användning av organisationer |
|
authenticateUser
|
authenticateUser | boolean |
Inför autentisering av undertecknare |
|
clientId
|
clientId | string |
Klient-ID |
|
skapad
|
created | number |
Skapad datum |
|
emUrl
|
emUrl | string |
Evidences manager Url |
|
hideDownloads
|
hideDownloads | boolean |
Nedladdningslänkar för dokument visas inte på medgivandesidor |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Döljer QR-koderna på constent-sidor |
|
Id-nummer
|
id | string |
Sid-ID för medgivande |
|
isCountryRequired
|
isCountryRequired | boolean |
Gör land obligatorisk information om undertecknare |
|
isDisabled
|
isDisabled | boolean |
Sidan Medgivande är inaktiverad |
|
logoResourceId
|
logoResourceId | string |
ID för medgivandesidans logotypresurs |
|
name
|
name | string |
Namnet på medgivandesidan |
|
primaryColor
|
primaryColor | string |
Primär färg för samtyckessidan |
|
secondaryColor
|
secondaryColor | string |
Sekundär färg för medgivandesida |
|
sharedPassphrase
|
sharedPassphrase | string |
Delad lösenfras |
|
signeringsläge
|
signing mode | string |
Signeringsläge (lokal eller server) |
|
stepType
|
stepType | string |
stegtyp (signatur eller godkännande) |
|
tenantId
|
tenantId | string |
Hyresgäst-ID |
|
tsaUrl
|
tsaUrl | string |
Url för tidsstämpelutfärdarutfärdar |
|
uppdaterad
|
updated | number |
Datum för senaste ändring |
|
verifyEmail
|
verifyEmail | boolean |
Om värdet är inställt på tue får undertecknarna OTPs via e-post |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Om värdet är true får undertecknarna OTP:er via sms |
consentPages
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totaltAntalArtiklar
|
totalItems | integer |
totaltAntalArtiklar |
kontakt
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
country
|
country | string |
Kontaktland |
|
skapad
|
created | integer |
Datum då kontakten skapades |
|
Mejladress
|
string |
Kontakta e-post |
|
|
förnamn
|
firstName | string |
Kontakta firstName |
|
Id-nummer
|
id | string |
Kontakt-ID |
|
efternamn
|
lastName | string |
Kontakta lastName |
|
name
|
name | string |
Kontaktnamn (förnamn + efternamn)) |
|
telefonnummer
|
phoneNumber | string |
Telefonnummer för kontakt |
|
tenantId
|
tenantId | string |
Hyresgäst-ID |
|
uppdaterad
|
updated | integer |
Kontakta senaste ändringsdatum |
|
userId
|
userId | string |
ID för kontaktens ägare |
contacts
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totaltAntalArtiklar
|
totalItems | integer |
totaltAntalArtiklar |
dataMappning
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
beskrivning
|
data1.description | string |
Beskrivning av metadata |
|
name
|
data1.name | string |
Metadatanamn |
|
pattern
|
data1.pattern | string |
Metadatamönster |
|
options
|
data1.options | array of object |
options |
|
värde
|
data1.options.value | string |
Metadatavärde |
|
type
|
data1.type | string |
type |
|
beskrivning
|
data2.description | string |
Beskrivning av metadata |
|
name
|
data2.name | string |
Metadatanamn |
|
pattern
|
data2.pattern | string |
Metadatamönster |
|
options
|
data2.options | array of object |
options |
|
värde
|
data2.options.value | string |
Metadatavärde |
|
type
|
data2.type | string |
type |
|
beskrivning
|
data3.description | string |
Beskrivning av metadata |
|
name
|
data3.name | string |
Metadatanamn |
|
pattern
|
data3.pattern | string |
Metadatamönster |
|
options
|
data3.options | array of object |
options |
|
värde
|
data3.options.value | string |
Metadatavärde |
|
type
|
data3.type | string |
type |
|
beskrivning
|
data4.description | string |
Beskrivning av metadata |
|
name
|
data4.name | string |
Metadatanamn |
|
pattern
|
data4.pattern | string |
Metadatamönster |
|
options
|
data4.options | array of object |
options |
|
värde
|
data4.options.value | string |
Metadatavärde |
|
type
|
data4.type | string |
type |
|
beskrivning
|
data5.description | string |
Beskrivning av metadata |
|
name
|
data5.name | string |
Metadatanamn |
|
pattern
|
data5.pattern | string |
Metadatamönster |
|
options
|
data5.options | array of object |
options |
|
värde
|
data5.options.value | string |
Metadatavärde |
|
type
|
data5.type | string |
type |
|
beskrivning
|
data6.description | string |
Beskrivning av metadata |
|
name
|
data6.name | string |
Metadatanamn |
|
pattern
|
data6.pattern | string |
Metadatamönster |
|
options
|
data6.options | array of object |
options |
|
värde
|
data6.options.value | string |
Metadatavärde |
|
type
|
data6.type | string |
type |
|
beskrivning
|
data7.description | string |
Beskrivning av metadata |
|
name
|
data7.name | string |
Metadatanamn |
|
pattern
|
data7.pattern | string |
Metadatamönster |
|
options
|
data7.options | array of object |
options |
|
värde
|
data7.options.value | string |
Metadatavärde |
|
type
|
data7.type | string |
type |
|
beskrivning
|
data8.description | string |
Beskrivning av metadata |
|
name
|
data8.name | string |
Metadatanamn |
|
pattern
|
data8.pattern | string |
Metadatamönster |
|
options
|
data8.options | array of object |
options |
|
värde
|
data8.options.value | string |
Metadatavärde |
|
type
|
data8.type | string |
type |
dokument
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
skapad
|
created | integer |
Skapad datum |
|
groupId
|
groupId | string |
ID för dokumentägarens grupp |
|
Id-nummer
|
id | string |
ID för dokumentet |
|
delar
|
parts | array of part |
delar |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
ID för dokumentets signaturprofil |
|
tenantId
|
tenantId | string |
Klientorganisations-ID |
|
uppdaterad
|
updated | integer |
Datum för senaste ändring |
|
userId
|
userId | string |
Användar-ID för dokumentägare |
|
visaAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista över grupper som kan visa dokumentet |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Lista över användare som tillåts visa dokumentet |
|
workflowId
|
workflowId | string |
ID för arbetsflödet som dokumentet tillhör |
|
workflowName (arbetsflöde)
|
workflowName | string |
Namnet på arbetsflödet som dokumentet tillhör |
Dokument
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totaltAntalArtiklar
|
totalItems | integer |
totaltAntalArtiklar |
layout
Metadatalayout
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
skapad
|
created | number |
Skapad datum |
|
Id-nummer
|
id | string |
Layout-ID |
|
isDisabled
|
isDisabled | boolean |
Om värdet är sant har layouten inaktiverats |
|
name
|
name | string |
Namnet på layouten |
|
tenantId
|
tenantId | string |
ID för klientorganisationen |
|
uppdaterad
|
updated | number |
Datum för senaste ändring |
|
dataKonfigurationer
|
dataConfigurations | array of object | |
|
springa
|
dataConfigurations.slot | string |
Metadataobjekt (data1 till data8) |
|
default
|
dataConfigurations.default | string |
Standardvärde för metadata i den här layouten |
|
optional
|
dataConfigurations.optional | boolean |
Om sant är det inte obligatoriskt att ange ett värde för dessa metadata |
|
ReadOnly
|
dataConfigurations.readonly | boolean |
Dessutom kan värdet åsidosättas |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Om värdet är inställt på sant bevaras värdet mellan arbetsflöden |
Layouter
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
skapad
|
items.created | number |
Skapad datum |
|
dataKonfigurationer
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Antal objekt per sida |
|
pageIndex
|
pageIndex | number |
Index för den returnerade sidan |
|
totaltAntalArtiklar
|
totalItems | number |
Totalt antal objekt som berörs av begäran |
part
Dokumentdel
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
innehållstyp
|
contentType | string |
innehållstyp |
|
filename
|
filename | string |
filename |
|
hasch
|
hash | string |
hasch |
|
size
|
size | integer |
size |
pdfSigField
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
skapad
|
created | number |
Skapad datum |
|
documentType
|
documentType | string |
Typ av dokument |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Tvinga undertecknaren att rulla längst ned i dokumentet |
|
Id-nummer
|
id | string |
signaturprofil-ID:t |
|
isDefault
|
isDefault | boolean |
Gör den här signaturprofilen till standardprofil |
|
isDisabled
|
isDisabled | boolean |
Inaktivera den här signaturprofilen |
|
name
|
name | string |
Namn på signaturprofil |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Text som visas i signaturer |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Färgen på texten som visas i singatures pads |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Storleken på texten som visas i singatures pads |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Synligt signaturläge (tillåtet, inaktiverat, noImage) |
|
Signaturtyp
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
Hyresgäst-ID |
|
uppdaterad
|
updated | number |
Datum för senaste ändring |
signatureProfiles
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Antal objekt per sida |
|
pageIndex
|
pageIndex | number |
Index för den returnerade sidan |
|
totaltAntalArtiklar
|
totalItems | number |
Totalt antal objekt som berörs av begäran |
user
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
Om värdet är sant kan användaren godkänna dokument |
|
country
|
country | string |
Användarens land |
|
skapad
|
created | integer |
Skapad datum |
|
Mejladress
|
string |
E-post för den här användaren |
|
|
förnamn
|
firstName | string |
Användarens förnamn |
|
groupId
|
groupId | string |
ID för användarens grupp |
|
Id-nummer
|
id | string |
Användarens ID |
|
isDisabled
|
isDisabled | boolean |
Om sant är användaren inaktiverad |
|
lastLogin
|
lastLogin | integer |
Användarens senaste inloggningsdatum |
|
efternamn
|
lastName | string |
Användarens efternamn |
|
name
|
name | string |
Användarens namn (förnamn + efternamn) |
|
organizationTitles
|
organizationTitles | array of |
Användarens funtioner i hans organisationer |
|
telefonnummer
|
phoneNumber | string |
Användarens telefonnummer |
|
signAllowed
|
signAllowed | boolean |
Om värdet är true kan användaren signera dokument |
|
ämne
|
subject | string |
Användarens interna underkect-kod |
|
tenantId
|
tenantId | string |
ID för klientorganisationen |
|
uppdaterad
|
updated | integer |
Datum för senaste ändring |
|
visaAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista över grupper där användaren kan fungera som övervakare |
arbetsflöde
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
skapad
|
created | integer |
skapad |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Metadata 1 |
|
data2
|
data2 | string |
Metadata 2 |
|
data3
|
data3 | string |
Metadata 3 |
|
data4
|
data4 | string |
Metadata 4 |
|
data5
|
data5 | string |
Metadata 5 |
|
data6
|
data6 | string |
Metadata 6 |
|
data7
|
data7 | string |
Metadata 7 |
|
data8
|
data8 | string |
Metadata 8 |
|
beskrivning
|
description | string |
Beskrivning av arbetsflödet |
|
Mejladress
|
string |
E-post till arbetsflödesägaren |
|
|
förnamn
|
firstName | string |
Förnamn för arbetsflödesägaren |
|
groupId
|
groupId | string |
ID för arbetsflödesägarens grupp |
|
Id-nummer
|
id | string |
ID för arbetsflödet |
|
efternamn
|
lastName | string |
Arbetsflödets ägares efternamn |
|
layoutId
|
layoutId | string |
ID för arbetsflödets metadatalayout |
|
logs
|
logs | array of |
Loggar objekt i wokflow |
|
name
|
name | string |
Namn (förnamn + efternamn) för arbetsflödesägaren |
|
notifiedEvents
|
notifiedEvents | array of string |
Lis av händelser som meddelas av arbetsflödet |
|
Förlopp
|
progress | integer |
Arbetsflödets förlopp i procent |
|
steps
|
steps | array of object |
steps |
|
allowComments
|
steps.allowComments | boolean |
Tillåter/förbjuder interaktiva kommentarer som tillåts i steget |
|
hideAttachments
|
steps.hideAttachments | boolean |
Styr visning av bifogade filer för undertecknare |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Styr visningen av andra undertecknare till undertecknaren |
|
Id-nummer
|
steps.id | string |
Steg-ID |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
ärStartad
|
steps.isStarted | boolean |
ärStartad |
|
logs
|
steps.logs | array of |
logs |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
Mejladress
|
steps.recipients.email | string |
Mejladress |
|
förnamn
|
steps.recipients.firstName | string |
förnamn |
|
efternamn
|
steps.recipients.lastName | string |
efternamn |
|
telefonnummer
|
steps.recipients.phoneNumber | string |
telefonnummer |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
uppdaterad
|
updated | integer |
uppdaterad |
|
userId
|
userId | string |
userId |
|
visaAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista över grupper där användare kan agera som observatörer |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
Mejladress
|
watchers.email | string |
Mejladress |
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totaltAntalArtiklar
|
totalItems | integer |
totaltAntalArtiklar |
binär
Det här är den grundläggande datatypen "binär".