DocumentenByTypeAndPid |
Geeft alle bijlagen voor het opgegeven documenttype terug uit een administratie. Voor deze operatie zijn de volgende scopes benodigd:- documenten:read
Catalogus: SnelStart
Schema: Documenten
Dit is een alleen-lezen tabelfunctie. De SnelStart API biedt mogelijk geen ondersteuning voor het wijzigen van de data of het Invantive SQL-stuurprogramma voor SnelStart ondersteunt dit niet. In het laatste geval gebruikt u de tabel NativePlatformScalarRequests om gegevens te uploaden naar de SnelStart-API.
Parameters van de tabelfunctie
De volgende parameters kunnen worden gebruikt om het gedrag van de tabelfunctie DocumentenByTypeAndPid in te stellen. Voor verplichte parameters moet altijd een waarde worden opgegeven, maar optionele parameters hoeven in het algemeen geen waarde te hebben en de uitvoering zal standaard een vooraf bepaald gedrag vertonen. Waarden kunnen worden gespecificeerd op basis van positie en naam. In beide gevallen worden alle niet-gespecificeerde parameters geëvalueerd aan de hand van hun standaardwaarden.
Waardespecificatie op positie gebeurt door alle waarden van de eerste tot de laatste benodigde waarde op te sommen. Bijvoorbeeld: een `select * uit tabel(waarde1, waarde2, waarde3)` op een tabel met vier parameters zal de standaardwaarde voor de vierde parameter gebruiken en de opgegeven waarden voor de eerste drie.
Waardespecificatie op naam gebeurt door alle waarden die een waarde vereisen op te sommen. Bijvoorbeeld met `selecteer * uit tabel(naam1 => waarde1, naam3 => waarde3)` op dezelfde tabel zullen de standaardwaarden voor de tweede en vierde parameter worden gebruikt en de opgegeven waarden voor de eerste en derde.
Naam |
Datatype |
Verplicht |
Standaardwaarde |
Documentatie |
---|---|---|---|---|
documenttype |
string |
☑ |
|
Het documenttype (mogelijke waarde: Inkoopboekingen, Verkoopboekingen of Relaties), waarvan de documenten worden opgevraagd. |
pid |
string |
☑ |
|
Format - uuid. De identifier als <seealso cref="T:System.Guid" /> uit het <seealso cref="T:SnelStart.B2B.Api.V2.Models.Documenten.DocumentIdentifierModel" /> van document van het opgegeven DocumentType/>. |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie DocumentenByTypeAndPid worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
---|---|---|---|---|
fileName |
string |
Bestandsnaam |
☐ |
De naam van de bijlage. |
id |
guid |
ID |
☐ |
De publieke sleutel (public identifier, als <a href="https://docs.microsoft.com/en-us/dotnet/api/System.Guid?view=netframework-4.6.2" target="_blank">System.Guid</a>) dat uniek een object identificeert. |
readOnly |
boolean |
Alleen-lezen |
☐ |
De bijlage is alleen-lezen. |
verkoopBoekingId |
guid |
Verkoopboeking ID |
☐ |
De public identifier van de gekoppelde verkoopboeking. |
10-02-2023 22:31 Versie 22.1.122-BETA+3761