Oodrive-teken (preview)
Verbind de Oodrive-aanmeldingsservice en verbruik deze via uw werkstromen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Oodrive-teken |
| URL | https://www.oodrive.com/products/oodrive-sign/ |
| E-mailen | support-sign@oodrive.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Oodrive-teken |
| Webpagina | https://www.oodrive.com/products/oodrive-sign/ |
| Privacybeleid | https://www.oodrive.com/privacy-policy/ |
| Categorieën | IT-bewerkingen; Productiviteit |
Met de connector van Oodrive Sign kunt u taken automatiseren en uw processen eenvoudig beheren over het ecosysteem van elektronische handtekeningen. Geautomatiseerde werkstroom kan worden ontworpen om bijvoorbeeld een nieuw contract te maken met een sjabloon, ontvangers automatisch toe te voegen en het contract voor handtekening te verzenden. U kunt ook al uw bundels, geadresseerden, sleutelparameters en meer beheren. Het biedt de klanten de mogelijkheid om de tijd te verkorten die wordt gebruikt om handmatige acties uit te voeren na al het handtekeningproces. Alle functies die beschikbaar zijn in de webtoepassing, kunnen worden gereproduceerd in Power Automate met behulp van de connector.
Vereiste voorwaarden
U hebt een account nodig met een betaald abonnement op de Oodrive Sign-service.
Referenties ophalen
U moet ook uw API-token ophalen, dat kan worden gevraagd aan de ondersteuningsservice of het kan worden opgehaald in uw gastvrije e-mail die naar uw postvak is verzonden wanneer u de service van Sign hebt toegepast.
Note: If you are a employee, you can get the token by contacting your IT service.
Aan de slag met uw connector
Als u de connector wilt gaan gebruiken, moet u eerst Power Automate openen met uw Power Platform-account.
Note: you'll need to be premium on Power Automate in order to use the connector.
Volg deze stappen om een nieuwe werkstroom te maken en onze connector te gebruiken:
- Klik in uw Power Automate-omgeving op het tabblad Maken.
- Kies 'Geautomatiseerde cloudstroom' of 'Directe cloudstroom', zoals u nodig hebt.
- Geef uw nieuwe werkstroom een naam en selecteer een trigger die aan uw behoeften voldoet. U kunt een van Oodrive Sign's gebruiken.
- Begin met het gebruik van de connector door er een actie van toe te voegen, door te zoeken naar 'Oodrive-aanmelding' in de catalogus.
- De eerste keer dat u een actie of een trigger toevoegt vanuit onze connector, vraagt Power Automate u verbinding te maken met uw omgeving: dit is er dat u het API-token van ons gebruikt.
- Klik vervolgens op Verbinding maken: alles is voltooid, u kunt zoveel acties van de gewenste connector gebruiken.
Bekende problemen en beperkingen
Neem contact op met de ondersteuningsservice voor problemen met Oodrive Sign.
Veelvoorkomende fouten en oplossingen
HTTP-FOUT 404
Over het algemeen geldt dat wanneer u een fout 404 krijgt met Oodrive-aanmeldingen, u ziet dat de ressource die u probeert te vinden niet in uw omgeving bestaat. Normaal gesproken kan het een fout zijn in de id die is opgegeven voor een specifiek contract of een specifieke geadresseerde, die niet bestaat. U kunt het probleem oplossen door uw actie te gebruiken met een bekende id van de ressource die u probeert op te halen.
HTTP-FOUT 501
De HTTP-fout 501 geeft aan dat de service van Oodrive Sign uw vraag niet goed heeft herkend of dat u een onjuist type gegevens aan de service hebt doorgegeven. Probeer te onderzoeken door de documentatie van Sign te lezen over de gegevens die u doorgeeft aan uw actie of trigger.
Veelgestelde vragen
1. Hoe kan ik een document uploaden naar een specifiek contract?
Met de actie 'Een document uploaden en aan een contract toevoegen' kunt u eenvoudig een PDF-bestand uploaden dat op afstand is opgeslagen.
Voor de eerste stap moet u de inhoud ophalen van het bestand dat u wilt uploaden. U kunt deze ophalen met behulp van veel connectors. Bestandsinhoud kan bijvoorbeeld worden opgehaald met behulp van de actie Bestandsinhoud ophalen van de SharePoint-connector.
- Haal de inhoud op van het bestand dat u wilt uploaden als document voor een specifiek contract. In dit voorbeeld gebruiken we de actie Bestandsinhoud ophalen van de SharePoint Online-connector.
- Voeg vervolgens een nieuwe 'opstellen'-actie toe. Gebruik de uitvoertekst van de actie 'Bestandsinhoud ophalen' als invoer voor het opstellen.
- Voeg de actie 'Een document uploaden en toevoegen aan een contract' toe vanuit de Oodrive Sign-connector.
- Geef in de invoer 'Contract-id' de id op van het contract waarvoor u het document wilt toevoegen.
- Voeg in de invoer 'Bestanden' de uitvoer van de vorige actie Opstellen in
- Voeg in de invoer 'Bestanden (bestandsnaam)' een naam in voor het document dat wordt geüpload.
- U bent klaar met het uploaden van het document.
2. Kan ik alle contracten in mijn omgeving zien?
Als uw token een 'administrator'-token is, ja. Anders bekijkt u alleen het contract waartoe u normaal toegang hebt.
3. Ik heb een suggestie voor de connector. Waar kan ik het indienen?
U kunt suggesties over de connector indienen door contact op te leggen met de ondersteuningsservice. Wij zullen u zeer dankbaar zijn voor uw bijdrage!
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| API-sleutel | beveiligde string | De API-sleutel voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Alle geadresseerden weergeven |
Haal alle geadresseerden op die zijn gekoppeld aan de huidige licentie. |
| Alle perimeters weergeven |
Haal alle perimeters op die zijn gekoppeld aan de verbonden omgeving. |
| Contract maken en verzenden voor handtekening |
Alles in één bewerking. Maak een contract, voeg geadresseerden, documenten toe en verzend het voor handtekening naar geadresseerden. |
| Contracten in een bundel valideren |
Tellerteken (valideer) alle contracten in een bundel. |
| De contracten van een bundel vermelden |
Haal alle contracten op uit een specifieke bundel. |
| De documenten van het contract downloaden |
Haal een PDF-bestand op dat alle documenten uit een contract bevat. |
| De documenten van het contract vermelden |
Alle documenten ophalen die aan een contract zijn gebonden. |
| De e-mailmelding opnieuw verzenden naar alle geadresseerden |
Verzend een e-mailmelding naar alle geadresseerden van een specifiek contract. |
| De geadresseerden van een contract vermelden |
Haal alle geadresseerden voor een specifiek contract op. |
| De status van een contract ophalen |
Controleer de status van een specifiek contract. |
| De transactie van een contract stoppen |
Stop de transactie van het contract zodat u contractdocumenten en/of ondertekenaars kunt wijzigen. |
| E-mailmelding opnieuw verzenden naar een geadresseerde |
Verzend een e-mailmelding naar een specifieke geadresseerde voor een contract. |
| Een bijlage uploaden en toevoegen aan een contract |
Upload een nieuwe bijlage naar de omgeving en koppel deze aan een specifiek contract. |
| Een bundel intrekken |
Trek alle contracten in een bundel in. |
| Een bundel maken |
Maak een nieuwe bundel met ten minste één bestaand contract. |
| Een bundel voor handtekening verzenden |
Verzend een bundel voor handtekening. |
| Een bundeltransactie stoppen |
Stop een bundeltransactie. |
| Een contract intrekken |
Stel de status van het contract in op VERLATEN, zelfs als het contract is verzonden voor ondertekening. |
| Een contract maken |
Maak een nieuw contract in de omgeving. |
| Een contract toevoegen aan een bundel |
Voeg een bestaand contract toe aan een bestaande bundel. |
| Een contract valideren |
Een contract valideren (tegenteken). |
| Een document uploaden en toevoegen aan een contract |
Upload een document naar de omgeving en voeg het toe aan een specifiek contract. |
| Een geadresseerde toevoegen aan een contract |
Voeg een bestaande geadresseerde toe aan het contract. |
| Een geadresseerde voor een contract verwijderen |
Verwijder een geadresseerde uit een contract door zijn ontvanger voor contract-id. Meer informatie in de documentatie. |
| Een lijst met alle contracten ophalen |
Haal alle contracten op uit de bijbehorende licentie. |
| Een specifiek contract ophalen |
Metagegevens van een specifiek contract ophalen. |
| Een specifieke geadresseerde ophalen |
Haal een specifieke geadresseerde op in de opgeslagen lijst met geadresseerden van de huidige omgeving. |
| Een te ondertekenen contract verzenden |
Stuur een specifiek contract en al zijn documenten om te worden ondertekend door geadresseerden. |
| Handtekeningen van een contract ophalen |
Geef alle handtekeninggegevens van een specifiek contract weer. |
| Het bewijsbestand van een contract downloaden |
Download het bewijsbestand van het contract. |
| Het ondertekende document van een contract downloaden |
Haal een PDF-bestand op uit het ondertekende document van het contract. |
Alle geadresseerden weergeven
Haal alle geadresseerden op die zijn gekoppeld aan de huidige licentie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Grootte
|
size | integer |
Maximale grootte van de geretourneerde matrix. |
|
|
Offset
|
offset | integer |
Volgnummer van de eerste vermelde geadresseerde. |
|
|
Omtrek
|
perimeter | string |
Zoek alleen in de opgegeven perimeter. |
|
|
Aangepaste props ophalen
|
get_custom_props | boolean |
Aangepaste eigenschappen van geadresseerden vermelden (verhoogt de reactietijd). |
|
|
Perimeters ophalen
|
get_perimeters | boolean |
Lijst met perimeters van geadresseerden in de antwoorden (verhoogt de reactietijd). |
|
|
Achternaam filteren (bevat)
|
name | string |
Filter op de achternaam. |
|
|
E-mail filteren (bevat)
|
string |
Filter op het e-mailbericht. |
Retouren
- Ontvangers
- array of Recipient
Alle perimeters weergeven
Haal alle perimeters op die zijn gekoppeld aan de verbonden omgeving.
Retouren
- response
- array of Perimeter
Contract maken en verzenden voor handtekening
Alles in één bewerking. Maak een contract, voeg geadresseerden, documenten toe en verzend het voor handtekening naar geadresseerden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
contract_id | integer |
De id van het contract. |
|
|
Aanmaakdatum
|
date | integer |
De datum waarop het contract is gemaakt. |
|
|
E-mailadres van leverancier
|
vendor_email | string |
E-mailadres van de eigenaar van de licentie van Oodrive. |
|
|
Id van contractdefinitie
|
contract_definition_id | integer |
Id van de contractdefinitie die voor dit contract wordt gebruikt. |
|
|
Berichtonderwerp
|
message_title | string |
E-mailonderwerp bij verzending voor handtekening. |
|
|
Berichttekst
|
message_body | string |
Hoofdtekst van e-mail wanneer deze wordt verzonden voor handtekening. |
|
|
Contractnaam
|
name | True | string |
De naam van het hoofddocument van het contract. |
|
Offlinehandtekening geactiveerd
|
keep_on_move | boolean |
Bepaal of de offlinehandtekening op een mobiel apparaat is geactiveerd. |
|
|
Gesloten datum van contract
|
closed_date | integer |
Datum van sluiting van het contract, indien aanwezig. |
|
|
Geannuleerde reden voor contract
|
canceled_reason | string |
Reden van de annulering, indien aanwezig. |
|
|
Automatisch sluiten ingeschakeld
|
auto_close | integer |
Geef aan of het contract automatisch wordt ondertekend of een menselijke tussenkomst nodig heeft. |
|
|
Wordt verwijderd
|
deleted | integer |
Geef op of het contract is verwijderd of niet. |
|
|
Perimetersleutel
|
Perimeters | string |
Sleutel van de perimeter. |
|
|
Optie-id
|
id | integer |
Id van de optie van het contract. |
|
|
Contract-id
|
contract_id | integer |
Id van het contract dat aan deze optie is gebonden. |
|
|
Definitie-id van element
|
element_definition_id | integer |
Id van de elementdefinitie van de optie. |
|
|
Synchronisatietimer
|
sync_timer | integer |
Timer die wordt gebruikt voor synchronisatieprobleem. |
|
|
Optiewaarde
|
value | string |
Waarde van de optie. |
|
|
Laatste wijzigingsplaats
|
last_modification_place | string |
Geeft aan waar de laatste wijziging heeft plaatsgevonden. |
|
|
Besturingselement voor opties
|
control | string |
Besturingselementveld. |
|
|
Eigenschaps-id
|
id | integer |
Id van de aangepaste eigenschap. |
|
|
Eigenschapssleutel
|
key | string |
Sleutel van de aangepaste eigenschap. |
|
|
Tijdelijke aanduiding voor eigenschap
|
placeholder | string |
Label dat wordt weergegeven aan de geadresseerde wanneer u wordt uitgenodigd om de eigenschap in te vullen. |
|
|
Eigenschapswaarde
|
value | string |
Waarde van de aangepaste eigenschap. |
|
|
Contract-id van eigenschap
|
contract_id | integer |
Id van het contract dat is gekoppeld aan deze aangepaste eigenschap. |
|
|
Eigenschap is vereist
|
to_fill_by_user | boolean |
Geef op of de gebruiker de eigenschap moet invullen of niet. |
|
|
Eigenschapstype
|
field_type | string |
Geef het type van de aangepaste eigenschap op. Meer informatie in de documentatie. |
|
|
Eigenschappenkeuzen
|
input_filter | string |
Lijst met mogelijke keuzen voor de eigenschap. |
|
|
Eigenschap wordt gebruikt door contract
|
used_by_contract | boolean |
Ingesteld op waar als de informatie moet worden weergegeven in het contractdocument. |
|
|
Eigenschap is vereist
|
required | boolean |
Geef op of de eigenschap vereist is of niet. |
|
|
Handtekeningmodus
|
signature_mode | integer | ||
|
voornaam
|
firstname | string | ||
|
achternaam
|
lastname | string | ||
|
e-mailadres
|
string | |||
|
cell_phone
|
cell_phone | string | ||
|
pdfparts
|
pdfparts | string | ||
|
bijlageonderdelen
|
appendixparts | string |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
recipients
|
recipients | array of Recipient | |
|
recipientForcontract
|
recipientForcontract | array of ContractRecipient | |
|
contract
|
contract | Contract | |
|
PDF
|
pdfparts | array of object |
Matrix van PDF die is gebonden aan het contract. |
|
PDF-id
|
pdfparts.id | integer |
Id van het PDF-bestand. |
|
PDF-rangschikking
|
pdfparts.rank | integer |
Rangschikking van het PDF-bestand. |
|
Heeft SmartFields
|
pdfparts.has_smart_field | boolean |
Geef op of er slimme velden in het contract zijn. |
|
PDF-grootte
|
pdfparts.size | integer |
De grootte van het document. |
|
Bestandsnaam
|
pdfparts.filename | string |
Naam van het pdf-bestand. |
|
bijlageonderdelen
|
appendixparts | array of object | |
|
identiteitskaart
|
appendixparts.id | integer |
Contracten in een bundel valideren
Tellerteken (valideer) alle contracten in een bundel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bundel-id
|
id | True | string |
Id van de bundel om alle contracten te valideren. |
|
Validatie afdwingen
|
force | boolean |
Dwing de validatie van de contracten af als sommige ondertekenaars nog niet zijn ondertekend (of hebben geweigerd om te ondertekenen). |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
date
|
date | string |
Datum van sluitingsstatus. |
|
Contract-id
|
id | string |
Id van het contract gestopt. |
De contracten van een bundel vermelden
Haal alle contracten op uit een specifieke bundel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bundel-id
|
id | True | string |
Id van de bundel waaruit contracten moeten worden opgehaald. |
Retouren
- response
- array of ContractInBundle
De documenten van het contract downloaden
Haal een PDF-bestand op dat alle documenten uit een contract bevat.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om het PDF-bestand op te halen. |
|
Naam van uitvoerbestand
|
filename | string |
De naam van het bestand dat wordt gedownload. |
Retouren
- PDF-document binair
- file
De documenten van het contract vermelden
Alle documenten ophalen die aan een contract zijn gebonden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om documenten op te halen. |
Retouren
- response
- array of DocumentAdded
De e-mailmelding opnieuw verzenden naar alle geadresseerden
Verzend een e-mailmelding naar alle geadresseerden van een specifiek contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om de melding opnieuw te verzenden. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Geef op of de melding opnieuw is verzonden. |
De geadresseerden van een contract vermelden
Haal alle geadresseerden voor een specifiek contract op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om alle geadresseerden op te halen. |
Retouren
- response
- array of ContractRecipient
De status van een contract ophalen
Controleer de status van een specifiek contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | integer |
Id van het contract om de status op te halen. |
Retouren
- Body
- Transaction
De transactie van een contract stoppen
Stop de transactie van het contract zodat u contractdocumenten en/of ondertekenaars kunt wijzigen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract dat moet worden gestopt. |
|
Kracht
|
force | boolean |
De transactie sluiten afdwingen, zelfs als ondertekenaars al zijn ondertekend. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Geef op of het contract is geannuleerd. |
E-mailmelding opnieuw verzenden naar een geadresseerde
Verzend een e-mailmelding naar een specifieke geadresseerde voor een contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om de melding opnieuw te verzenden. |
|
Ontvanger voor contract-id
|
cfc_id | True | string |
Id van de ontvanger van het contractobject om een melding te verzenden. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Geef op of de melding opnieuw is verzonden. |
Een bijlage uploaden en toevoegen aan een contract
Upload een nieuwe bijlage naar de omgeving en koppel deze aan een specifiek contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om een bijlage toe te voegen. |
|
Id van contractdefinitie
|
contract_definition_id | integer |
Contractdefinitie-id gedefinieerd in uw omgeving. De standaardwaarde is pdfadhoc. |
|
|
Naam van optiedefinitie
|
option_definition_name | string |
Definitienaam. |
|
|
Files
|
file | array |
Bestanden die moeten worden toegevoegd als bijlagen |
Retouren
- Body
- AppendixAdded
Een bundel intrekken
Trek alle contracten in een bundel in.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bundel-id
|
id | True | string |
Id van de bundel om alle contracten in te trekken. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Zegt of bundel is ingetrokken. |
Een bundel maken
Maak een nieuwe bundel met ten minste één bestaand contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
contract_id | integer |
De id van het eerste contract van de bundel. |
|
|
Dezelfde ondertekenaars
|
same_signatories | boolean |
Ingesteld op onwaar als contracten in de bundel niet dezelfde set ondertekenaars hebben. |
Retouren
- Body
- BundleResponse
Een bundel voor handtekening verzenden
Verzend een bundel voor handtekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bundel-id
|
id | True | string |
Id van de bundel die moet worden verzonden voor handtekening. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Geeft aan of de transactie is verzonden of niet. |
Een bundeltransactie stoppen
Stop een bundeltransactie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bundel-id
|
id | True | string |
Id van de bundel om de transactie te stoppen. |
|
Sluiten afdwingen
|
force | boolean |
Transactie sluiten afdwingen, zelfs als ondertekenaars al zijn ondertekend. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Zegt dat de bundel is gestopt. |
Een contract intrekken
Stel de status van het contract in op VERLATEN, zelfs als het contract is verzonden voor ondertekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract dat moet worden ingetrokken. |
|
Reden
|
reason | string |
De reden van de intrekking. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Geef op of het contract is geannuleerd. |
Een contract maken
Maak een nieuw contract in de omgeving.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam van het contract
|
name | string |
Naam van het zojuist gemaakte contract (vereist). |
|
|
Id van contractdefinitie
|
contract_definition_id | integer |
Id van de contractdefinitie. Raadpleeg de API-variabele van uw licentie. Standaard een PDF AdHoc-sjabloon. |
|
|
E-mail van leverancier
|
vendor_email | string |
E-mail van de eigenaar van de licentie. |
|
|
Aanmaakdatum
|
date | integer |
Datum van het contract. Standaard ingesteld op Date.Now(). Moet in milliseconden staan. |
|
|
Berichttitel
|
message_title | string |
Object van het verzonden e-mailbericht. Laat leeg voor een standaardtitel. |
|
|
Berichttekst
|
message_body | string |
Hoofdtekst van het verzonden e-mailbericht. Laat leeg voor een standaardbericht. |
|
|
Onderweg blijven
|
keep_on_move | boolean |
Handtekening via off-line activeren of niet op een mobiel apparaat |
|
|
Automatisch sluiten
|
auto_close | integer |
Geef op of tegentekening wordt uitgevoerd zonder menselijke tussenkomst. |
|
|
Sequentieel
|
sequential | boolean |
Geef op of sequentiële of niet. |
|
|
Klantnummer
|
customer_number | string |
Alleen voor compatibiliteit met oudere mobiele toepassingen. |
|
|
Lijst met perimeter
|
perimeters | array of string | ||
|
Id van elementdefinitie
|
element_definition_id | integer |
Definitie-id van het element. |
|
|
Waarde
|
value | string |
Waarde van de elementoptie. |
|
|
Eigenschaps-id
|
id | integer |
Id van de aangepaste eigenschap. |
|
|
Eigenschapssleutel
|
key | string |
Sleutel van de aangepaste eigenschap. |
|
|
Tijdelijke aanduiding voor eigenschap
|
placeholder | string |
Label dat wordt weergegeven aan de geadresseerde wanneer u wordt uitgenodigd om de eigenschap in te vullen. |
|
|
Eigenschapswaarde
|
value | string |
Waarde van de aangepaste eigenschap. |
|
|
Contract-id van eigenschap
|
contract_id | integer |
Id van het contract dat is gekoppeld aan deze aangepaste eigenschap. |
|
|
Eigenschap is vereist
|
to_fill_by_user | boolean |
Geef op of de gebruiker de eigenschap moet invullen of niet. |
|
|
Eigenschapstype
|
field_type | string |
Geef het type van de aangepaste eigenschap op. Meer informatie in de documentatie. |
|
|
Eigenschappenkeuzen
|
input_filter | string |
Lijst met mogelijke keuzen voor de eigenschap. |
|
|
Eigenschap wordt gebruikt door contract
|
used_by_contract | boolean |
Ingesteld op waar als de informatie moet worden weergegeven in het contractdocument. |
|
|
Eigenschap is vereist
|
required | boolean |
Geef op of de eigenschap vereist is of niet. |
Retouren
- Body
- Contract
Een contract toevoegen aan een bundel
Voeg een bestaand contract toe aan een bestaande bundel.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bundel-id
|
id | True | string |
Id van de bundel om een contract toe te voegen. |
|
Contract-id
|
contract_id | integer |
Id van het contract dat moet worden toegevoegd aan de bundel. |
Retouren
- Body
- BundleResponse
Een contract valideren
Een contract valideren (tegenteken).
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract dat moet worden gevalideerd. |
|
Kracht
|
force | boolean |
Geef aan of de contractvalidatie moet worden afgedwongen, zelfs als sommige ondertekenaars nog niet zijn ondertekend. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Validatiedatum
|
date | string |
Datum van validatie. |
|
Transactie-id
|
id | string |
De transactie-id van de certificeringsinstantie. |
Een document uploaden en toevoegen aan een contract
Upload een document naar de omgeving en voeg het toe aan een specifiek contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract waaraan een nieuw document moet worden gekoppeld. |
|
Bestand
|
file | file |
Bestand binair bestand dat moet worden geüpload. |
Retouren
- response
- array of DocumentAdded
Een geadresseerde toevoegen aan een contract
Voeg een bestaande geadresseerde toe aan het contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om geadresseerde bij te voegen. |
|
Geadresseerde-id
|
recipient_id | integer |
Id van de geadresseerde die aan het contract moet worden gekoppeld. |
|
|
Handtekeningmodus
|
signature_mode | integer |
De handtekeningmodus. Raadpleeg de documentatie voor meer informatie. |
|
|
Berichttitel
|
message_title | string |
Titel van het bericht dat per e-mail moet worden verzonden als er een is. |
|
|
Berichtinhoud
|
message_body | string |
Hoofdtekst van het bericht dat per e-mail moet worden verzonden als er een bericht is. |
|
|
Rang
|
rank | integer |
Plaats van de ontvanger in het handtekeningproces. Rang en Smartrole sluiten elkaar wederzijds uit. Kies slechts één van deze of helemaal niet. |
|
|
Naam van slimme rol
|
smartrole | string |
Slimme rol die aan de ontvanger moet worden verstrekt. Raadpleeg de documentatie voor meer informatie. |
|
|
Transportmodus
|
transport_mode | integer |
Transportmodus van de handtekening. Raadpleeg de documentatie voor meer informatie. |
Retouren
- response
- array of ContractRecipient
Een geadresseerde voor een contract verwijderen
Verwijder een geadresseerde uit een contract door zijn ontvanger voor contract-id. Meer informatie in de documentatie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Ontvanger voor contract-id
|
cfc_id | True | string |
Id van de ontvanger van het contractobject dat moet worden verwijderd. |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
slagen
|
succeed | boolean |
Geef op of deze is verwijderd. |
Een lijst met alle contracten ophalen
Haal alle contracten op uit de bijbehorende licentie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Grootte van de geretourneerde matrix
|
size | integer |
De maximale grootte van de geretourneerde matrix van contract. |
|
|
Eerste n contracten overslaan
|
offset | integer |
Het volgnummer van het contract dat wordt overgeslagen. |
|
|
Contracteigenschappen weergeven
|
get_properties | boolean |
Indien waar, worden contracteigenschappen weergegeven in het antwoord. |
|
|
Contractperimeter weergeven
|
get_perimeters | boolean |
Indien waar, worden contractperimeters weergegeven in het antwoord. |
|
|
Gemaakt voor
|
before | integer |
Geeft een lijst weer van het contract dat is gemaakt vóór de opgegeven datum. |
|
|
Gemaakt na
|
after | integer |
Geeft een contract weer dat is gemaakt na de opgegeven datum. |
|
|
Alleen met perimeter
|
perimeter | string |
Lijst met contracten alleen in een bepaalde perimeter. |
|
|
Alleen met status
|
status | array |
Haal het contract alleen op met de opgegeven status. |
Retouren
- Artikelen
- ArrayOfContract
Een specifiek contract ophalen
Metagegevens van een specifiek contract ophalen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
De contract-id die moet worden opgehaald. |
Retouren
- Body
- Contract
Een specifieke geadresseerde ophalen
Haal een specifieke geadresseerde op in de opgeslagen lijst met geadresseerden van de huidige omgeving.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Geadresseerde-id
|
id | True | string |
Id van de ontvanger die moet worden opgehaald. |
Retouren
- Body
- Recipient
Een te ondertekenen contract verzenden
Stuur een specifiek contract en al zijn documenten om te worden ondertekend door geadresseerden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract dat moet worden verzonden voor handtekening. |
Retouren
- Body
- Transaction
Handtekeningen van een contract ophalen
Geef alle handtekeninggegevens van een specifiek contract weer.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om alle handtekeningen weer te geven. |
Retouren
Het bewijsbestand van een contract downloaden
Download het bewijsbestand van het contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | string |
Id van het contract om het bewijsbestand te downloaden. |
|
Naam van uitvoerbestand
|
filename | string |
De naam van het bestand dat wordt gedownload. |
Retouren
- response
- file
Het ondertekende document van een contract downloaden
Haal een PDF-bestand op uit het ondertekende document van het contract.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Contract-id
|
id | True | integer |
Id van het contract dat documenten bevat. |
|
Bestandsnaam
|
filename | string |
De naam die u aan het gedownloade document wilt geven. |
Retouren
Binaire inhoud van het PDF-bestand.
- Binair document
- file
Triggers
| Wanneer de status van een contract verandert |
Deze bewerking wordt geactiveerd wanneer de status van een contract is gewijzigd. |
Wanneer de status van een contract verandert
Deze bewerking wordt geactiveerd wanneer de status van een contract is gewijzigd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
beschrijving
|
description | string |
beschrijving |
|
|
events
|
events | array of string |
events |
|
|
contractDefinition
|
contractDefinition | array of integer |
contractDefinition |
|
|
omtrek
|
perimeter | array of integer |
omtrek |
|
|
betrokkenUserEmail
|
concernedUserEmail | string |
betrokkenUserEmail |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | string |
type |
|
contractId
|
contractId | integer |
contractId |
|
tijdstempel
|
timestamp | integer |
tijdstempel |
|
contractStatus
|
contractStatus | string |
contractStatus |
Definities
ArrayOfContract
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
Contract |
Overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
Contract-id
|
contract_id | integer |
De id van het contract. |
|
Aanmaakdatum
|
date | integer |
De datum waarop het contract is gemaakt. |
|
Documenttoken
|
document_token | string |
Token van het hoofddocument van het contract. |
|
E-mailadres van leverancier
|
vendor_email | string |
E-mailadres van de eigenaar van de licentie van Oodrive. |
|
Is gesloten
|
closed | boolean |
Geef op of het contract al dan niet is gesloten. |
|
Contractstatus
|
status | string |
De huidige status van het contract. |
|
Id van contractdefinitie
|
contract_definition_id | integer |
Id van de contractdefinitie die voor dit contract wordt gebruikt. |
|
Berichtonderwerp
|
message_title | string |
E-mailonderwerp bij verzending voor handtekening. |
|
Berichttekst
|
message_body | string |
Hoofdtekst van e-mail wanneer deze wordt verzonden voor handtekening. |
|
Contractnaam
|
name | string |
De naam van het hoofddocument van het contract. |
|
Offlinehandtekening geactiveerd
|
keep_on_move | boolean |
Bepaal of de offlinehandtekening op een mobiel apparaat is geactiveerd. |
|
Gesloten datum van contract
|
closed_date | integer |
Datum van sluiting van het contract, indien aanwezig. |
|
Geannuleerde reden voor contract
|
canceled_reason | string |
Reden van de annulering, indien aanwezig. |
|
Versienummer van contract
|
version_number | integer |
Versienummer van het contract. |
|
Contractgrootte
|
size | integer |
Volledige grootte van het contract. |
|
Automatisch sluiten ingeschakeld
|
auto_close | integer |
Geef aan of het contract automatisch wordt ondertekend of een menselijke tussenkomst nodig heeft. |
|
Wordt verwijderd
|
deleted | integer |
Geef op of het contract is verwijderd of niet. |
|
Perimeters
|
perimeters | array of ContractPerimeterKey |
Lijst met alle perimeters van het contract (indien opgevraagd). |
|
Options
|
options | array of ContractOption |
Lijst met alle specifieke opties van het contract (indien opgevraagd). |
|
Aangepaste eigenschappen
|
contract_properties | array of ContractProperty |
Lijst met alle optionele contracteigenschappen (indien opgevraagd). |
ContractOption
| Name | Pad | Type | Description |
|---|---|---|---|
|
Optie-id
|
id | integer |
Id van de optie van het contract. |
|
Contract-id
|
contract_id | integer |
Id van het contract dat aan deze optie is gebonden. |
|
Definitie-id van element
|
element_definition_id | integer |
Id van de elementdefinitie van de optie. |
|
Synchronisatietimer
|
sync_timer | integer |
Timer die wordt gebruikt voor synchronisatieprobleem. |
|
Optiewaarde
|
value | string |
Waarde van de optie. |
|
Laatste wijzigingsplaats
|
last_modification_place | string |
Geeft aan waar de laatste wijziging heeft plaatsgevonden. |
|
Besturingselement voor opties
|
control | string |
Besturingselementveld. |
ContractProperty
| Name | Pad | Type | Description |
|---|---|---|---|
|
Eigenschaps-id
|
id | integer |
Id van de aangepaste eigenschap. |
|
Eigenschapssleutel
|
key | string |
Sleutel van de aangepaste eigenschap. |
|
Tijdelijke aanduiding voor eigenschap
|
placeholder | string |
Label dat wordt weergegeven aan de geadresseerde wanneer u wordt uitgenodigd om de eigenschap in te vullen. |
|
Eigenschapswaarde
|
value | string |
Waarde van de aangepaste eigenschap. |
|
Contract-id van eigenschap
|
contract_id | integer |
Id van het contract dat is gekoppeld aan deze aangepaste eigenschap. |
|
Eigenschap is vereist
|
to_fill_by_user | boolean |
Geef op of de gebruiker de eigenschap moet invullen of niet. |
|
Eigenschapstype
|
field_type | string |
Geef het type van de aangepaste eigenschap op. Meer informatie in de documentatie. |
|
Eigenschappenkeuzen
|
input_filter | string |
Lijst met mogelijke keuzen voor de eigenschap. |
|
Eigenschap wordt gebruikt door contract
|
used_by_contract | boolean |
Ingesteld op waar als de informatie moet worden weergegeven in het contractdocument. |
|
Eigenschap is vereist
|
required | boolean |
Geef op of de eigenschap vereist is of niet. |
ContractPerimeterKey
ContractRecipient
| Name | Pad | Type | Description |
|---|---|---|---|
|
Ontvanger voor contract-id
|
recipient_for_contract_id | integer |
Unieke id van het paarcontract en de ontvanger. |
|
Geadresseerde-id
|
recipient_id | integer |
Id van de ontvanger. |
|
Contract-id
|
contract_id | integer |
Id van het contract. |
|
Handtekeningstatus
|
signature_status | string |
Status van het tekenteken. |
|
Handtekeningdatum
|
signature_date | integer |
Tijdstempel van de datum van het tekenteken. |
|
Handtekeningmodus
|
signature_mode | integer |
Tekenmarkeringsmodus. |
|
Berichttitel
|
message_title | string |
Titel van het bericht. |
|
Berichtinhoud
|
message_body | string |
Hoofdtekst van het bericht. |
|
Rang
|
rank | integer |
Rangschikken in het tekenproces. |
|
Slimme rol
|
smartrole | string |
Slimme rol die is gekoppeld aan de ontvanger. |
|
Transportmodus
|
transport_mode | integer |
Transportmodus. |
|
Handtekening-id
|
signature_id | string |
Id van de handtekening van de geadresseerde. |
DocumentAdded
| Name | Pad | Type | Description |
|---|---|---|---|
|
Document-id
|
id | integer |
Id van het document. |
|
Rang
|
rank | integer |
Plaats deze in de lijst met documenten. |
|
Heeft SmartField
|
has_smart_field | boolean |
Geef op of het document SmartFields heeft. |
|
Documentgrootte
|
size | integer |
De grootte van het document in bytes. |
|
Documentnaam
|
filename | string |
Naam van het document. |
Transactie
| Name | Pad | Type | Description |
|---|---|---|---|
|
Contracttransactie-id
|
transaction_id | string |
Geef de transactie-id op die is gebonden aan het contract. |
|
Is gesloten
|
is_closed | boolean |
Geef op of het contract is gesloten. |
|
Contractnaam
|
contract_name | string |
Naam van het contract. |
|
Contractstatus
|
status | string |
Geef de status van het contract op. |
Omtrek
| Name | Pad | Type | Description |
|---|---|---|---|
|
Perimeter-id
|
id | integer |
Id van de perimeter. |
|
Perimetersleutel
|
key | string |
Sleutel van de perimeter (gebruikt door contracten). |
|
beschrijving
|
description | string |
Beschrijving van de omtrek. |
RecipientForContractWithRefusal
| Name | Pad | Type | Description |
|---|---|---|---|
|
Ontvanger voor contract-id
|
recipient_for_contract_id | integer |
Id van het object dat het contract en de ontvanger heeft gebonden. |
|
Geadresseerde-id
|
recipient_id | integer |
Id van de geadresseerde van de handtekening. |
|
Handtekeningstatus
|
signature_status | string |
Status van de handtekening. |
|
Handtekeningdatum
|
signature_date | integer |
Datum van de laatste wijzigingen van de handtekening. |
|
Handtekeningmodus
|
signature_mode | integer |
Modus van de handtekening. |
|
Berichttitel
|
message_title | string |
Titel van het bericht dat is gebonden aan de handtekening van het contract. |
|
Berichtinhoud
|
message_body | string |
Hoofdtekst van het bericht dat is gebonden aan de handtekening van het contract. |
|
Rang
|
rank | integer |
Rang van de ontvanger van de handtekening in het contractproces. |
|
Naam van slimme rol
|
smartrole | string |
Rol van de ontvanger van de handtekening in het contract. |
|
Transportmodus
|
transport_mode | integer |
Transportmodus van het contract gebonden aan de handtekening. |
|
Handtekening-id
|
signature_id | string |
Id van de handtekening. |
|
Heeft weigering
|
has_refusal | boolean |
Geef op of de ontvanger het contract heeft geweigerd. |
|
Laatste weigeringsdatum
|
last_refusal_date | integer |
Geef de datum van weigering op. |
|
Laatste weigeringsbericht
|
last_refusal_message | string |
Geef het weigeringsbericht op. |
ContractInBundle
| Name | Pad | Type | Description |
|---|---|---|---|
|
Contract-id
|
id | integer |
Id van het contract. |
|
Contractnaam
|
name | string |
Naam van het contract. |
|
Type contractdefinitie
|
contract_definition_type | string |
Type definitie van het contract. |
|
Id van contractdefinitie
|
contract_definition_id | integer |
Id van de definitie van het contract. |
|
Bedrijfsnaam
|
company_name | string |
Naam van het bedrijf dat aan het contract is gebonden. |
Recipient
| Name | Pad | Type | Description |
|---|---|---|---|
|
Geadresseerde-id
|
id | integer |
Id van de ontvanger. |
|
Beleefdheid
|
civility | string |
Civiliteit van de ontvanger |
|
Voornaam
|
firstname | string |
Voornaam van de ontvanger. |
|
Achternaam
|
lastname | string |
Achternaam van de ontvanger. |
|
Hoofdadres
|
address_1 | string |
Hoofdadres van de geadresseerde. |
|
Postcode
|
postal_code | string |
Postcode van de geadresseerde. |
|
City
|
city | string |
Plaats van de ontvanger. |
|
Mobiel telefoonnummer
|
cell_phone | string |
Mobiel telefoonnummer van de ontvanger. |
|
E-mailadres
|
string |
E-mailadres van de geadresseerde. |
|
|
Country
|
country | string |
Land van de ontvanger. |
|
Secundair adres
|
address_2 | string |
Secundair postadres van de geadresseerde. |
|
Bedrijfsnaam
|
company_name | string |
Bedrijfsnaam van de ontvanger. |
|
Telefoonnummer
|
phone | string |
Telefoonnummer van de geadresseerde. |
|
Functietitel
|
job_title | string |
Functie van de geadresseerde. |
|
Geboortedatum
|
birthdate | integer |
Geboortedatum (tijdstempel) van de ontvanger. |
|
Geboortedatum
|
birthplace | string |
Geboortedatum van de ontvanger. |
|
custom_properties
|
custom_properties | array of RecipientProperty | |
|
perimeters
|
perimeters | array of string |
RecipientProperty
| Name | Pad | Type | Description |
|---|---|---|---|
|
Eigenschaps-id
|
id | integer |
Id van de eigenschap. |
|
Eigenschapssleutel
|
key | string |
Sleutel van de eigenschap. |
|
Eigenschapswaarde
|
value | string |
Waarde van de eigenschap. |
|
Aannemer-id
|
contractor_id | integer |
Id van de aannemer. |
|
Synchronisatietimer
|
sync_timer | integer |
Timer van de laatste synchronisatie. |
|
Laatste wijzigingsplaats
|
last_modification_place | string |
Locatie van de laatste wijziging. |
BijlageAdded
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bijlage-id
|
id | integer |
Id van de bijlage. |
|
Bijlagenaam
|
filename | string |
Naam van de bijlage. |
|
Optie-id van bijlage
|
option_id | integer |
Optie-id voor de bijlage |
|
Bijlage-inhoudstype
|
content_type | string |
Inhoudstype van de bijlage (bijvoorbeeld afbeelding/jpeg). |
BundleResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bundel-id
|
id | integer |
Id van de bundel. |
|
Auteur-id
|
actor_id | integer |
Id van de maker van de bundel. |
|
Eerste contract-id
|
contract_id | integer |
Id van het eerste contract van de gemaakte bundel. |
|
Bundelstatus
|
status | integer |
Status van de bundel. |
|
Bundelmodel
|
master | integer |
Meester van de bundel. |
bestand
Dit is het basisgegevenstype 'bestand'.