| Info |
|---|
...
An vielen Feldern in der Ad API werden bestimmte Werte erwartet. Teilweise sind die Werte abhängig von den Werten anderer Felder, teilweise handelt es sich um fixe Werte. Der Endpunkt “/valuelists” ermöglicht die Abfrage der möglichen Werte, wenn keine weiteren Abhängigkeiten bestehen. |
Funktionalitäten des Endpunktes
Abfrage von Strukturdaten
Abfrage von Werten, die ohne Einschränkungen am jeweiligen Feld erlaubt sind
Inhaltsverzeichnis
| Expand | ||||
|---|---|---|---|---|
| ||||
|
Allgemeine Beschreibung
| Note |
|---|
Vor Veröffentlichung der Seite löschen: Hier findest du Regeln & Tipps zum Erstellen einer Dokumentation /wiki/spaces/CORE/pages/108003857. Bitte daran denken:
|
Verwandte Seiten
Das untenstehende Makro “Inhalt nach Stichwort” bearbeiten und in der Seitenleiste unter “Stichwort *” das Label “dummy” durch das Label des Moduls / Features ersetzen (s. dazu https://peiq.atlassian.net/wiki/spaces/CORE/pages/108003857/How+To+Knowledge+Base#Verwandte-Seiten).
Dann diesen Hinweis entfernen (auf Mülleimer drücken).
...
An vielen Feldern in der Ad API werden in den Requests bestimmte Werte erwartet. Der GET am Endpunkt “/valuelists” ermöglicht die Abfrage dieser möglichen Werte für alle Felder, bei denen die Werte unabhängig von anderen Merkmalen feststehen.
Der aktuelle Funktionsumfang kann über Swagger UI eingesehen werden: https://mt-master-create.peiq.cloud/adapi/adapi.html#/Structure%20data/get_valuelists
...
Parameter
Die Abfrage am Endpunkt “/valuelists” erfolgt unter Verwendung folgender Parameter:
“object_type”: bezeichnet das betroffene Objekt / den Endpunkt, wie z. B.:
business_partner
business_partner_information
address
contact_option
order
ad
cipher
sale
supplement
account_details
discount_agreement
special_publication
“field_name”: Name des Feldes am gewählten Objekt
Rückgabewerte
"strict_values_only" (“true” / “false”):
“true” bedeutet, dass zwingend einer der definierten Werte anzugeben ist
“false” bedeutet, dass auch abweichende Werte akzeptiert werden
“dependent_fields”: kann aktuell vernachlässigt werden (Vorbereitung für eine mögliche Erweiterung für Wertelisten mit abhängigen Werten).
"value_sets": Auflistung der definierten Werte (“value”) und Beschreibungen (“comment”)
Übersicht der abrufbaren Felder
“object_type” | “field_name” |
|---|---|
business_partner_information | billing_client |
business_partner_information | customer_group |
business_partner_information | tariff_class |
business_partner_information | credit_rating_category |
business_partner_information | credit_rating_index |
business_partner_information | additional_discount_type |
business_partner_information | discount |
business_partner_information | additional_discount |
business_partner_information | invoice_type |
business_partner_information | invoicing_period |
business_partner_information | invoice_proof_type |
business_partner_information | publication_proof_type |
business_partner_information | term_of_payment |
address | type |
address | title |
address | degree |
address | country |
contact_option | type |
contact_option | country_code |
contact_option | purposes |
order | billing_client |
order | tariff_class |
order | acceptance_type |
order | invoicing_period |
order | vat_type |
order | invoice_type |
order | publication_proof_type |
order | invoice_proof_type |
order | discount |
order | additional_discount_type |
order | additional_discount |
order | campaign |
order | term_of_payment |
order | billing_type |
ad | colors_booked |
ad | colors_to_charge |
ad | design_notes |
ad | online_period |
ad | online_bookingtype |
ad | online_placement |
ad | online_format |
ad | online_calculation |
ad | online_times |
ad | publication_type |
ad | copy_variant |
ad | production_status |
ad | sales_office |
ad | workflow_control |
cipher | delivery_type |
sale | type |
supplement | type |
supplement | weight |
supplement | quantity_booked |
supplement | quantity_delivered |
supplement | quantity_inserted |
discount_agreement | billing_client |
discount_agreement | type |
discount_agreement | status |
discount_agreement | due |
discount_agreement | eligibilities |
special_publication | billing_client |
special_publication | category |
Verwandte Seiten
| Filter by label (Content by label) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Include Page | ||||
|---|---|---|---|---|
|
Nur für PEIQ-Mitarbeiter: Link der internen Core-Seite (Inline Link)