Functies
Functionele Documentatie
Deze module bevat functies voor het manipuleren van documentgegevens en het uitvoeren van verschillende bewerkingen met betrekking tot documentvelden.
Functies
set_field_value()
Stelt de waarde van een veld in de documentgegevens in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het in te stellen veld
value*
any
De waarde die voor het veld moet worden ingesteld
remove_link (optioneel)
bool
Verwijder de "coords" sleutel uit het veld.
set_date_value()
Stelt de waarde van een datumveld in de documentgegevens in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het in te stellen veld
value*
string
De datumwaarde die in ISO-formaat moet worden ingesteld (bijv. "2020-12-31").
add_days (optioneel)
int
Voeg extra dagen toe aan de gegeven datum Standaard is 0
skip_weekend (optioneel)
bool
Overslaat de datum als deze in het weekend valt
Standaard is False
remove link (optioneel)
bool
Verwijder de "coords" sleutel uit het veld.
exclude_final_days (optioneel)
of string of int
Geeft de dagen op die moeten worden uitgesloten (0-6 of zondag tot zaterdag)
set_amount_value()
Stelt de waarde van een bedragveld in de documentgegevens in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het in te stellen veld
value*
string
De waarde die voor het veld moet worden ingesteld (geef een nummer als string door, bijv. "123456")
remove link (optioneel)
bool
Verwijder de "coords" sleutel uit het veld.
get_field_value()
Haalt de waarde van een veld uit de documentgegevens.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het in te stellen veld
default_value (optioneel)
any
Geeft default_value terug als er geen veldwaarde wordt gevonden
Standaard is None
is_clean (optioneel)
bool
Converteert de waarde naar hoofdletters en verwijdert extra spaties
Standaard is False
Retourneert:
Waarde van het opgegeven veld
create_new_field()
Maakt een nieuw veld met de opgegeven naam en waarde.
Parameters:
field_name*
str
De documentgegevens met veldinformatie
value (optioneel)
any
De initiële waarde voor het veld
Standaard is ""
Retourneert:
Woordenboek van het nieuw aangemaakte veld
delete_field()
Verwijdert een veld uit de documentgegevens
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het te verwijderen veld
Retourneert:
Document_data als json en als dict nadat het veld is verwijderd
set_is_required()
Stelt het 'is_required' attribuut van een veld in de documentgegevens in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het in te stellen veld
value*
bool
De waarde die voor het veld moet worden ingesteld
set_force_validation()
Stelt het 'force_validation' attribuut van een veld in de documentgegevens in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het in te stellen veld
value*
bool
De waarde die voor het veld moet worden ingesteld
reset_validation (optioneel)
bool
Stelt het "is_validated" attribuut in op de opgegeven waarde
Standaard is False
set_field_as_invalid()
Markeert een veld in het validatiescherm als ongeldig en markeert het.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het veld dat als ongeldig moet worden gemarkeerd
message*
string
Het validatiebericht voor het veld
code (optioneel)
string
Foutcode voor de validatie
Standaard is None
set_field_attribute()
Stelt een aangepast attribuut van een veld in de documentgegevens in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
field_name*
string
De naam van het in te stellen veld
attribute_name*
string
De naam van het in te stellen attribuut
value*
any
De waarde die voor het attribuut moet worden ingesteld
is_supplier_valid()
Controleert of een leverancier geldig is op basis van de opgegeven criteria.
Parameters:
user*
UserAuthentication
De geauthenticeerde gebruiker
filter_data_json*
json
Filtercriteria voor het valideren van de leverancier
sub_org_id (optioneel)
string
Optionele sub-organisatie-ID voor filtering
Standaard is None
Retourneert:
True, als de gebruiker geldig is
False als de gebruiker niet geldig is
get_document_content()
Decodeert documentgegevens en retourneert deze als een string.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
Retourneert:
Documentgegevens als een string.
update_document_status_with_doc_id()
Werk de status van een document met een specifieke ID bij naar de gegeven status.
Parameters:
doc_id*
string
De ID van het document dat moet worden bijgewerkt
user*
of user ID of UserAuthentication object
De gebruiker die de update uitvoert
org_id*
string
De ID van de organisatie waartoe het document behoort
status*
string
De nieuwe status van het document
message (optioneel)
string
Optioneel bericht dat aan de statusupdate is gekoppeld
Standaard is None
doc_classification_class (optioneel)
string
Optionele documentclassificatieklasse
Standaard is None
get_lov_values()
Haalt de LOV-waarden op van een specifieke org_id en sleutel.
Parameters:
org_id*
string
De ID van de organisatie waartoe het document behoort
key*
string
De sleutel van de vereiste Lijst Van Waarden
return_type (optioneel)
string
Het type waarin de gegevens moeten worden geretourneerd
Standaard is 'list_of_objects'
sub_org_id (optioneel)
string
Optionele sub-organisatie-ID voor filtering
Standaard is None
language_code (optioneel)
string
Deze parameter stelt de taal in waarin de waarden worden geretourneerd. Het accepteert taalcodes, zoals "en" voor Engels of "fr" voor Frans.
Standaard is ""
Retourneert:
LOV-waarden als een lijst van objecten of als een lijst.
format_decimal_to_locale()
Formatteert een decimale waarde naar en_US.UTF-8 formaat.
Parameters:
value*
float, decimal.Decimal, str
De waarde die moet worden geformatteerd.
to_locale (optioneel)
string
Het type waarin de gegevens moeten worden geretourneerd
Standaard is 'en_US.UTF-8'
max_decimal_places (optioneel)
int
Optionele sub-organisatie-ID voor filtering
Standaard is 4
min_decimal_places (optioneel)
int
Het minimum aantal decimalen dat moet worden overwogen
Standaard is 2
value: De waarde die moet worden geformatteerd.
to_locale (optioneel): Het formaat waarin de waarde wordt omgevormd.
max_decimal_places (optioneel): Het maximum aantal decimalen dat moet worden overwogen.
min_decimal_places (optioneel): Het minimum aantal decimalen dat moet worden overwogen.
Retourneert:
De geformatteerde waarde.
compare_values()
Vergelijkt twee waarden op gelijkheid, met verschillende datatypes.
Parameters:
value1*
any
De eerste waarde om te vergelijken
value2*
any
De tweede waarde om te vergelijken
Retourneert:
True als de waarden gelijk zijn en False als ze verschillen
create_document_task()
Maakt een taak, wijst deze toe aan een gebruiker of groep, stelt prioriteit in en verstuurt optioneel een e-mail.
Parameters:
user*
of user ID of UserAuthentication object
De gebruiker die de update uitvoert
document_data*
dictionary
De documentgegevens met veldinformatie
title*
string
De titel van de taak
description*
string
De beschrijving van de taak
priority*
string
De prioriteit van de taak
assigned_to_user_id*
int
De id van de gebruiker aan wie de taak moet worden toegewezen
assigned_to_group_id*
int
De id van de groep aan wie de taak moet worden toegewezen
send_email*
bool
Bepaal of er een e-mail moet worden verzonden of niet
Retourneert:
Dict dat aangeeft of het proces succesvol was of niet
set_document_sub_org_id()
Stelt de sub_org_id van de opgegeven document_data in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
sub_org_id*
string
Optionele sub-organisatie-ID voor filtering
get_user_by_id()
Haalt de gebruiker op met de bijbehorende gebruikers-ID.
Parameters:
user_id*
string
De ID van de gebruiker
Retourneert:
De gebruiker met de bijbehorende gebruikers-ID
get_group_by_id()
Haalt de groep op met de bijbehorende groeps-ID.
Parameters:
group_id*
string
De ID van de groep
Retourneert:
De groep met de bijbehorende groeps-ID
get_user_by_email()
Haalt de gebruiker op met de bijbehorende e-mail.
Parameters:
email*
any
De e-mail van de gebruiker
Retourneert:
De gebruiker met de bijbehorende e-mail
add_table_column()
Voegt een kolom toe aan de opgegeven tabel.
Parameters:
table*
string
De tabel waar de kolom aan moet worden toegevoegd
col_name*
string
De naam van de kolom
default_value (optioneel)
any
De initiële waarde voor het veld
Standaard is None
get_column_value()
Haalt de waarde op van een opgegeven kolom.
Parameters:
row*
string
De rij waar de waarde zich bevindt
col_name*
string
De naam van de kolom
default_value (optioneel)
any
De initiële waarde voor het veld
Standaard is None
is_clean (optioneel)
bool
Converteert de waarde naar hoofdletters en verwijdert extra spaties
Standaard is False
Retourneert
Retourneert de waarde van de opgegeven kolom als deze bestaat; anders retourneert het
None
set_column_value()
Stelt de waarde van de opgegeven kolom in. Als de kolom niet bestaat, wordt deze aangemaakt.
Parameters:
row*
string
De rij waar de waarde zich bevindt
col_name*
string
De naam van de kolom
value*
any
De waarde die op de opgegeven locatie moet worden ingesteld
Retourneert:
True als de wijziging succesvol was
set_column_date_value()
Stelt de datumwaarde van een opgegeven kolom in.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
row*
string
De rij waar de waarde zich bevindt
col_name*
string
De naam van de kolom
value*
string
De datumwaarde die in ISO-formaat moet worden ingesteld (bijv. "2020-12-31")
add_days (optioneel)
int
Voeg extra dagen toe aan de gegeven datum
Standaard is 2
skip_weekend (optioneel)
bool
Overslaat de datum als deze in het weekend valt
Standaard is False
exclude_final_days (optioneel)
of string of int
Geeft de dagen op die moeten worden uitgesloten (0-6 of zondag tot zaterdag)
set_column_amount_value()
Converteer waarde naar string en stel de waarde voor de kolom in
Stel de kolominhoud in op de waarde
Formatteer waarde volgens de locale
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
row*
string
De rij waar de waarde zich bevindt
column_name*
string
De naam van de kolom
value*
string
De waarde die voor het veld moet worden ingesteld (geef een nummer als string door, bijv. "123456")
delete_tables()
Deze functie verwijdert de tabellen uit de documentgegevens.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
restore_tables()
Deze functie herstelt de tabellen in de documentgegevens.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
remove_rows_from_table()
Verwijdert rijen uit de opgegeven tabel.
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
table_name*
string
De naam van de tabel
count*
int
Hoeveel lijnen moeten worden verwijderd
start*
int
Het startpunt
remove_all_rows_except_one_from_table()
Verwijdert alle rijen behalve één uit de opgegeven tabel
Parameters:
document_data*
dictionary
De documentgegevens met veldinformatie
line_number*
int
Het nummer van de regel die niet moet worden verwijderd
Python Ingebouwde Functies
Je kunt ook enkele van de ingebouwde Python-functies gebruiken:
abs(): Retourneert de absolute waarde van een getal.
len(): Retourneert de lengte (aantal items) van een object, zoals een lijst of string.
isinstance(): Controleert of een object een instantie is van een bepaalde klasse of type.
print(): Drukt output af naar de console.
round(): Rondt een drijvend getal af naar een opgegeven aantal decimalen.
str_to_bool(): Converteert een string naar een boolean waarde (True of False).
type(): Retourneert het type van een object.
dict(): Maakt een woordenboekobject aan.
list(): Maakt een lijstobject aan.
str(): Converteert een waarde naar een string.
float(): Converteert een waarde naar een drijvend getal.
int(): Converteert een waarde naar een geheel getal.
Voor meer details, bezoek de officiële Python-documentatie: Ingebouwde Functies.
String Klasse Functies
Je kunt ook deze functies specifiek voor het werken met strings gebruiken:
lower(): Converteert alle karakters in een string naar kleine letters.
upper(): Converteert alle karakters in een string naar hoofdletters.
split(): Splitst een string in een lijst op basis van een scheidingsteken (bijv. spatie of komma).
startswith(): Controleert of een string begint met een opgegeven voorvoegsel.
endswith(): Controleert of een string eindigt met een opgegeven achtervoegsel.
strip(): Verwijdert eventuele leidende of achterblijvende spaties uit een string.
Functies uit de Python Wiskunde Module
Deze functies maken deel uit van de wiskundemodule en zijn nuttig voor wiskundige bewerkingen:
floor(): Retourneert het grootste gehele getal dat kleiner is dan of gelijk is aan een gegeven getal.
ceil(): Retourneert het kleinste gehele getal dat groter is dan of gelijk is aan een gegeven getal.
Voor meer informatie, bekijk de officiële Python-documentatie: Wiskunde Module Functies.
Reguliere Expressie Functie
re.search(): Zoekt naar een patroon binnen een string en retourneert de eerste match.
Zie meer details hier: re.search Documentatie.
Externe Functies
Hier zijn enkele nuttige functies van externe bibliotheken:
deepcopy(): Maakt een kopie van een object, inclusief geneste objecten (van de copy-module). Deepcopy Documentatie.
levenshtein_distance(): Berekent het aantal bewerkingen (invoegingen, verwijderingen, vervangingen) dat nodig is om de ene string in de andere te veranderen. Deze functie is beschikbaar in de Jellyfish bibliotheek.
Datum en Tijd Functies
Je kunt de volgende functies gebruiken voor het werken met data en tijden:
strptime(): Converteert een string naar een datetime-object op basis van een opgegeven formaat.
strftime(): Formatteert een datetime-object naar een string op basis van een opgegeven formaat.
Voor meer informatie, bekijk de officiële documentatie: Datum en Tijd Functies.
Last updated
Was this helpful?