Standardlisten

In Alvine gibt es viele Schlüssel-/Werte-Listen für unterschieldiche Einsatzzwecke. Diese Listen können alle über die List-Api abgerufen werden.

Listen

Listname Beschreibung
account_address_country_specialfields Zusatzfelder (länderspezifisch) für Adressdaten (Liefer und Rechnugnsadresse)
account_address_type mögliche Typen von Adressdatensätzen
account_calendar_color Farben für die Kalenderdarstellung
account_calendar_events_alarm_action Aktionstypen für Kalenderevents
account_calendar_events_alarm_period mögliche Zeiten für die Errinnerung eines Kalendereintrages
account_calendar_events_alarm_type mögliche Zeiträume für die Wiederholung eines Kalendereintrages
account_calendar_events_duration mögliche Dauer eines Kalendereintrages
account_calendar_events_state möglicher Stauts eines Kalendereintrages
account_calendar_type Art des Kalender (gregorianisch,...)
account_chat_type mögliche Chattypen
account_command_set Befehlszusammenstellung für verschiedene Systembereiche
account_communication_scope mögliche Bereiche für Kommunikationdatensätze von Kunden
account_communication_type mögliche Typen für Kommunikationdatensätze von Kunden
account_companies_imagetype Liste der Mandantenbilder
account_companies_texttype Liste der Mandantentexte
account_companies_type mögliche Typen von Mandanten
account_company_crawler_exclude Liste mit Adressen von Crawlern bei denen ein redirect unterbunden werden soll
account_debug_priority Prioritätsstufen für das debuggen
account_debug_type mögliche Typen des debuggens
account_extra_workflow_object_state möglicher Status eines Arbeitsschrittes
account_marketing_exportmap Liste der exportierbaren Felder der Marketingadressen
account_measure mögliche Maßtypen
account_membership_history_type Typ des Historieneintrag der Mitgliedschaft
account_message_charset möglicher Charset der Nachricht
account_notice_type möglicher Typ einer Notiz
account_priority Liste von Prioritätstypen
account_properties_price_matrix Matrix für mögliche Preisberechnungen
account_relationship_address_type mögliche Typen von Adressdatensätzen bei Kundenbeziehungen
account_relationship_objecttype mögliche Typen einer Kundenbeziehungen
account_relationship_state möglicher Status einer Kundenbeziehung
account_relationship_type mögliche Typen von Kundenbeziehungen
account_ticket_message_type mögliche Typen von Ticketnachrichtetn
account_ticket_priority Liste von Prioritätstypen bei den Ticketnachrichten
account_ticket_state möglicher Status einer Ticketnachricht
account_timezone Liste aller Zeitzonen
account_todos_prio Liste von Prioritätstypen für Aufgaben
account_todos_progress möglicher Bearbeitungsstand einer Aufgabe
account_todos_scope mögliche Bereiche von Aufgaben
account_todos_state möglicher Status einer einer Aufgabe
account_user_community_action_types mögliche Typen von Kundenaktionen
account_user_community_chat_presence_types möglicher Status eines Users im Chat
account_user_crm_rating mögliche Typen von Kunden für das Payment-Rating
account_user_defaultproperties Standardeigenschaften von Benutzeren
account_user_exportmap Liste der möglichen Felder für den Export von Benutzern
account_user_import_propertymap Liste der möglichen zu importierenden Benutzereigenschaften
account_user_restricted_prefixes mögliche Präfixe für Benutzernamen
account_user_state möglicher Status eine Benutzers
administration_backup_filelist Liste der Verzeichnisse für ein mögliches Backup
administration_search Liste der erlaubten Befehle der Suchfunktion
amazon_de_browsenote Liste der Kategoriezuweisung für Amazon DE
amazon_de_chestsize Liste der Grössenzuweisung für Amazon DE
amazon_de_clothingtype Liste der Bekleidungstypen für Amazon DE
amazon_de_colormap Liste der Farbzuweisung für Amazon DE
amazon_de_cupsize Liste der Körbchengrössen für Amazon DE
amazon_de_department Liste der Zuweisung von Abteilungen für Amazon DE
amazon_de_materialopacity Liste der möglichen Materialtranzparenz für Amazon DE
amazon_de_season Liste der Saisonbezeichnungen für Amazon DE
amazon_de_sleevetype Liste der Ärmellängen für Amazon DE
amazon_uk_browsenode Liste der Kategoriezuweisung für Amazon UK
amazon_uk_clothingtype Liste der Bekleidungstypen für Amazon UK
amazon_uk_colormap Liste der Farbzuweisung für Amazon UK
amazon_uk_cupsize Liste der Körbchengrössen für Amazon UK
amazon_uk_department Liste der Zuweisung von Abteilungen für Amazon UK
amazon_uk_materialopacity Liste der möglichen Materialtranzparenz für Amazon UK
amazon_uk_season Liste der Saisonbezeichnungen für Amazon UK
amazon_uk_sleevetype Liste der Ärmellängen für Amazon UK
content_aggregation_map Liste möglicher Aggregationen für eine Navigation
content_charset möglicher Charset für Inhalte
content_cntags_type Typenliste für cn_tags
content_exporturl_state möglicher Status eines Eintrages beim URL-Export
content_frontend_plugins Liste von Plugins die einen Mailversand anstoßen
content_header_map Liste möglicher Content Header Types
content_html_color_names Liste mit Farbnamen
content_html_event_names Liste mit Eventnamen
content_json_collection Produktfelder die im Plugin shop.item.optimize ausgewählt werden können
content_knowledgebase Liste der Bereiche für die interne Knowledgebase
content_marketing_affiliate_templates Liste der Templates für ein Partner-Programm
content_metadata_placeholder Liste der Platzhalterfür die Metadaten
content_metadata_texttype Liste der Bereiche für die Metadaten
content_plugin_locale_directories Liste der Verzeichnisse der Übersetzungsdateien
content_rte_anchor_target Liste der Ankerziele für Links
content_rte_table_class mögliche Klassen für Tabellen in einem RTE
content_shorturl_exclude Liste mit Filtern/Plugins die für erstellen einer ShortURL ausgeschlossen sind
content_shorturl_name Liste mit definierten Zuweisungen bei bestimmten Bezeichnungen
content_simple_form_error_locale Standard Platzhalter für Fehlermeldungen im Plugin content.simple.form
content_simple_form_input_type mögliche Typen von Inputfeldern im Plugin conten.simple.form
content_simple_form_type_dummy_values Dummy Einträge für das Plugin content.simple.form
content_simple_form_verification_datatypes_dates Liste der erlaubte Datumsformate im Plugin content.simple.form
content_site_meta_robots mögliche Metawerte für eine Robotsdatei
content_siteacces_mode möglicher Status eines Seitenzugriffes
content_template_shop_item_gallery Liste der Templates für das Plugin shop.item.gallery
content_text_image_texttype Liste der Bereiche für Textfelder
content_text_name Liste der verfügbaren Textbausteine
content_text_scope Liste der Bereiche für Texte
content_text_state möglicher Status eines Textes
content_text_type möglicher Typ eines Textes
core_archived mögliche Werte für ein Archivefeld
core_delta_table_exclude DB-Tabellen / Felder die für die Delta Datenbereitstellung
core_delta_table_key Schlüsselfeld für die DB-Tabellen der Delta Datenbereitstellung
core_delta_table_type Typzuweisung der DB-Tabellen der Delta Datenbereitstellung
core_export_quotechars Liste der zu möglichen Zeichen zur Maskierung von Texten beim CSV Export
core_file_mime_map Liste von MimeTypes von Dateien
core_file_type_label Liste der Bezeichnungen für die MimeTypes von Dateien
core_file_type_name Liste der Namen für die MimeTypes von Dateien
core_form_allowed_requests Liste der erlaubten Formularfelder in einem Request
core_form_controls Liste der Bezeichnungen von Formularfeldern
core_frequency Liste mit Intervallangaben
core_iso_country_alpha3 Liste der Ländercodes nach ISO-3166-1 ALPHA 3
core_locale_country Liste der Länderbezeichnungen
core_locale_country_de Liste der Länderbezeichnungen DE
core_locale_country_en Liste der Länderbezeichnungen EN
core_locale_country_fr Liste der Länderbezeichnungen FR
core_locale_day Liste der Platzhalter für die Übersetzung der Wochentage
core_locale_language_region Liste für Country_Region Codes
core_locale_languages Liste mit Sprachbezeichnungen
core_locale_languages2 Liste mit Sprachbezeichnungen
core_locale_month Liste der Übersetzungen der Monatsbezeichnugen
core_mime_mediatype Liste von MimeTypes von Dateien
core_rte_styles Liste der Platzhalter für Übersetzungen der RTE Style Bezeichnungen
core_sql_operators Liste der Platzhalter für Übersetzungen der SQL Operatoren
core_timeinterval Liste der Wiederholungsintervalle der Ereignisverarbeitung
core_timeschedule Liste der Zeipläne zur Durchführung von Aufgaben
public_banner_payment mögliche Banner-Bezahlweisen
public_banner_trackingtype Banner Tracking Typ
public_gallery_text Album-Feldbeschreibung
public_item_incoterms Liste der Incoterms
public_item_marketing_fieldnames Übersetzungen für die Marketingfelder eines Produktes
public_item_numbers_type Liste mit möglichen Typen von Produktnummern
public_item_packingunit Liste mit Verpackungseinheiten
public_item_price_name Liste mit möglichen Preistypen
public_item_sales_group Liste mit möglichen Verkaufsgruppen
public_item_salestype Liste mit möglichen Verkaufstypen
public_item_shipping_type Lagertyp eines Produktes
public_item_specification_baseprice_reference Liste mit Grundpreisreferenzen
public_item_specification_lengthunit Liste möglicher Längeneinheiten
public_item_specification_squarelengthunit Liste möglicher Flächeneinheiten
public_item_specification_volumeunit Liste möglicher Volumeneinheiten
public_item_specification_weightunit Liste möglicher Gewichtseinheiten
public_item_style Liste der möglichen Styles
public_item_texttype Liste der vorhandenen Produkttexte
public_item_timeunit Liste mit Zeiteinheiten
public_objects Liste möglicher Veröffentlichungsbereiche
public_objects_label Liste der Bezeichnungen der Veröffentlichungsbereiche
public_objects_state möglicher Status eines Eintrages im Veröffentlichungsbereich
shop_addon_assignment1_imagetype Liste möglicher Bilder der Zuweisung 1
shop_addon_assignment1_texttype Liste möglicher Textfelder der Zuweisung 1
shop_addon_assignment2_imagetype Liste möglicher Bilder der Zuweisung 2
shop_addon_assignment2_texttype Liste möglicher Textfelder der Zuweisung 2
shop_addon_assignment3_imagetype Liste möglicher Bilder der Zuweisung 3
shop_addon_assignment3_texttype Liste möglicher Textfelder der Zuweisung 3
shop_addon_brand_imagetype Liste möglicher Bilder der Marken
shop_addon_brand_texttype Liste möglicher Textfelder der Marken
shop_addon_catalog_groupmap Liste mit möglichen Werten nach denen der Katalogexport gruppiert werden kann
shop_addon_catalog_ordermap Liste mit möglichen Werten nach denen der Katalogexport sortiert werden kann
shop_addon_category_imagetype Liste möglicher Bilder der Kategorien
shop_addon_category_texttype Liste möglicher Textfelder der Kategorien
shop_addon_collection_imagetype Liste möglicher Bilder der Kollektionen
shop_addon_collection_texttype Liste möglicher Textfelder der Kollektionen
shop_addon_color_imagetype Liste möglicher Bilder der Farben
shop_addon_color_texttype Liste möglicher Textfelder der Farben
shop_addon_department_imagetype Liste möglicher Bilder der Abteilungen
shop_addon_department_texttype Liste möglicher Textfelder der Abteilungen
shop_addon_material_imagetype Liste möglicher Bilder des Materials
shop_addon_material_texttype Liste möglicher Textfelder des Materials
shop_addon_size_order Liste möglicher Größenangaben
shop_addon_style_imagetype Liste möglicher Bilder der Styles
shop_addon_style_texttype Liste möglicher Textfelder der Styles
shop_addon_variant_regex Liste möglicher regulärer Ausdrücke wie Varianten zu behandeln sind
shop_chargetype Liste möglicher Gebührentypen
shop_companies_orderstate Liste der Statis von Mandantenbestellungen
shop_delivery_canceltext Gründe einer Stornierung von Artikeln einer Lieferung
shop_delivery_documents Liste der verfügbaren Lieferdokumente
shop_delivery_glscountrymapping Map der Länderzuweisung für Lieferungen über GLS
shop_delivery_remove_reason Gründe einer Löschung einer Lieferung
shop_delivery_state Liste der möglichen Stati einer Lieferung
shop_discount_additionalmintype mögliche Berechnungsgrundlagen für Konditionen
shop_discount_additionaltype Liste der Typen von Zugaben
shop_discount_chargetype mögliche Berechnungsgrundlagen für Zugaben
shop_extra_account_bank_nationaltypes mögliche Typen der Leitzahl der Bank
shop_extra_account_blacklist_icons Liste der Icons der Sperrliste
shop_extra_alvine_dumplist Liste der DB-Tabellen die bei einem Peering geleert werden
shop_extra_amazon_marketplaces Liste der Amazon Marketplaces
shop_extra_amazon_serviceurl Liste der Amazon Service-URLs
shop_extra_ceg_addresscode Map des Rückgabewertes der CEG Adressprüfung
shop_extra_ceg_ggoh_errormessage Map der Fehlermeldungen der CEG GGOH Feldprüfung
shop_extra_ceg_ggoh_errortypes Map der Fehlertypen der CEG GGOH Feldprüfung
shop_extra_ceg_trafficlight Map der Rückgabewerte der CEG GGDE Feldprüfung zur grafischen Darstellung
shop_extra_ebay_dispute_reason Liste der Gründe für einen eBay Disput
shop_extra_ebay_dispute_reason_explanation Liste der Erklärung des Grundes für einen eBay Disput
shop_extra_edi_document_process_state Liste eines möglichen Status einer EDI Dokumentenverarbeitung
shop_extra_edi_gateway_type Liste der möglichen Typen eines EDI Gateways
shop_extra_edi_orders_aggregation_types Liste der Aggregationsmöglichkeiten von EDI ORDERs
shop_extra_edi_slsrpt_aggregation_types Liste der Aggregationsmöglichkeiten von EDI SLSRPTs
shop_extra_finance_mt940_state möglicher Status eines MT940 Eintrages
shop_extra_finance_opos_interfacetype Liste der verfügbaren Interfaces für einen Opos Export
shop_extra_item_audience_imagetype Liste möglicher Bilder der Zielgruppen
shop_extra_item_audience_texttype Liste möglicher Textfelder der Zielgruppen
shop_extra_item_exportmap Liste der exportierbaren Felder eines Produktes
shop_extra_item_peering_exportmap Liste der exportierbaren Felder eines Produktes für das Peering
shop_extra_item_rating_state Liste der möglichen Stati einer Produktbewertung
shop_extra_item_rating_steps Liste der verschiedenen Ratings eines Produktes
shop_extra_item_season_imagetype Liste möglicher Bilder einer Saison
shop_extra_item_season_texttype Liste möglicher Textfelder einer Saison
shop_extra_janolaw_texttype Liste der verfügbaren Shoptexte für den Import der Schnittstelle zu Janolaw
shop_extra_logistic_collissimo_content mögliche Inhaltstypen einer Lieferung über den Logistik-Provider Collissimo
shop_extra_logistic_collissimo_nondeliveryinstructions mögliche Servicetypen bei einer Nicht-Lieferung über den Logistik-Provider Collissimo
shop_extra_logistic_collissimo_product Liste der Produkttypen des Logistik-Provider Collissimo
shop_extra_logistic_deliveryconditions_chargetype Liste der Kostentypen einer Lieferkondition
shop_extra_logistic_deliveryconditions_taretype Liste der möglichen Berechnungstypen einer Lieferkondition
shop_extra_logistic_dhl_method_international Liste verfügbare Methoden eines internationalen Versandes über den Logistik-Provider DHL
shop_extra_logistic_dhl_method_national Liste verfügbare Methoden eines nationalen Versandes über den Logistik-Provider DHL
shop_extra_logistic_dhl_product_international Liste der Produkttypen eines internationalen Versandes des Logistik-Provider DHL
shop_extra_logistic_dhl_product_national Liste der Produkttypen eines nationalen Versandes des Logistik-Provider DHL
shop_extra_logistic_dhl_service_international Liste der Servicetypen eines internationalen Versandes des Logistik-Provider DHL
shop_extra_logistic_dhl_service_national Liste der Produkttypen eines nationalen Versandes des Logistik-Provider DHL
shop_extra_logistic_dpd_option Liste möglicher Optionen eines Versandes des Logistik-Provider DPD
shop_extra_logistic_dpd_product Liste der Produkttypen eines Versandes des Logistik-Provider DPD
shop_extra_logistic_ups_accountinfo Liste möglicher Rechnungsempfänger des Logistik-Provider UPS
shop_extra_logistic_ups_packettype Liste der Produkttypen eines Versandes des Logistik-Provider UPS
shop_extra_logistic_ups_service_international Liste der Servicetypen eines internationalen Versandes des Logistik-Provider UPS
shop_extra_logistic_ups_service_national Liste der Servicetypen eines nationalen Versandes des Logistik-Provider UPS
shop_extra_marketing_antevorte_de_attributes Liste möglicher Produkt-Attribute für die Schnittstelle zu Antevorte
shop_extra_marketing_antevorte_de_caresymbols Mappingliste der Produkt-Pflegeneigenschaften für die Schnittstelle zu Antevorte
shop_extra_marketing_antevorte_de_mandatory_attributes Liste der Pflichtattribute der Kategorien für die Schnittstelle zu Antevorte
shop_extra_marketing_antevorte_de_recommended_attributes Liste der empfohlenen Attribute der Kategorien für die Schnittstelle zu Antevorte
shop_extra_marketing_credits Liste der möglichen Stati einer Gültigkeit eines Credit
shop_extra_marketing_mapping_affiliates_rules Liste der zu prüfenden Regeln für einen Produktexport
shop_extra_marketing_mapping_amazon_rules Liste der zu prüfenden Regeln für einen Amazon Produktexport
shop_extra_marketing_mapping_ebay_rules Liste der zu prüfenden Regeln für einen eBay Produktexport
shop_extra_marketing_mapping_neckermann_productfamily Mappingliste der Produktfamilienzuordnung für einen Neckermann Produktexport
shop_extra_marketing_mapping_neckermann_rules Liste der zu prüfenden Regeln für einen Neckermann Produktexport
shop_extra_marketing_mapping_otto_rules Liste der zu prüfenden Regeln für einen Otto Produktexport
shop_extra_marketing_mapping_zalando_rules Liste der zu prüfenden Regeln für einen Zalando Produktexport
shop_extra_marketing_otto_category_rules Liste der zu prüfenden Regeln für Produkt-Kategorien für einen Otto Produktexport
shop_extra_marketing_reference_condition Liste möglicher Stati der Ergebnisprüfung bei Anbindung an einen Vertriebskanal
shop_extra_marketing_specialoffer_additionalmintype Liste der Typen für die Berechnungsgrundlage von Gutscheinen
shop_extra_marketing_specialoffer_additionaltype Liste der möglichen Typen für eine Zugabe
shop_extra_marketing_specialoffer_assignmode Liste der möglichen Berechnungsgrundlagen der Gutscheine auf Positionsebene
shop_extra_marketing_zalando_colorgroup Liste der verfügbaren Farbgruppen für den Vertriebskanal Zalando
shop_extra_offer_offer_position_state Liste möglicher Stati von Angebotspositionen
shop_extra_offer_offer_state Liste möglicher Stati von Angeboten
shop_extra_order_subscripe_executestate Liste des Ausführungstatus einer Abo Bestellung
shop_extra_order_subscripe_interval Liste möglicher Intervalle von Abo Bestellungen
shop_extra_order_subscripe_state Liste der zur Verfügung stehenden Stati von Abo Bestellungen
shop_extra_order_subscripe_type Liste möglicher Typen einer Abo Bestellung
shop_extra_warehouse_orderingitems_functioncode Liste der anwendbaren EDIFACT Funktionscode
shop_extra_warehouse_orderingitems_state Liste möglicher Stati einer Position für die EDI ORDERS Datenübermittlung
shop_extra_warehouse_stock_location_type Liste möglicher Typen von Lagerplätzen
shop_invoice_infotext Liste verfügbarer Infotexte für Lieferungen
shop_item_gallery_jsonfeedkey Liste der Produktfelder die über einen json Aufruf zurückgegeben werden
shop_item_gallery_optimize_productfamiliy Liste der verfügbaren Felder für die Produktfamilie eines Artikels in der Shopgalerie
shop_item_reduced_productfamily reduzierte Liste der Felder für die Produktfamilie eines Artikels
shop_item_variants_properties Liste vorhandener Varianteneigenschaften eines Produktes
shop_itemavis_state Liste möglicher Stati eines Wareneingangs-Avis Eintrages
shop_navigation_display_items_jsonfeedkey Liste der Produktfelder die über einen json Aufruf zurückgegeben werden
shop_navigation_display_jsonfeedkey Liste mit weiteren Feldern die über einen json Aufruf zurückgegeben werden
shop_order_state Liste der möglichen Stati einer Bestellung
shop_order_visualcheck_failure_reason Liste der zur Verfügung stehenden Gründe um eine Bestellung auf fehlerhaft zu stellen
shop_payment_authorize_response_reason_codes Mappingliste der Rückantworten über das Paymentgateway authorize
shop_payment_card_type Liste auswählbarer Kreditkartentypen
shop_payment_datevtype Mappingliste von Paymenttypen für die DATEV Datenübertragung
shop_payment_state Liste möglicher Stati von Payment Transaktionen
shop_payment_type Liste verfügbarer Paymenttypen
shop_picklist_state Liste möglicher Stati einer Pickliste
shop_project_jobstate Liste möglicher Stati eines Jobs in der Projektverwaltung
shop_project_password_type Liste verfügbarer Typen eines Passwordlisteneintrages in der Projektverwaltung
shop_project_requirements_complexity mögliche Komplexität einer Anforderung in der Projektverwaltung
shop_project_requirements_priority mögliche Priorität einer Anforderung in der Projektverwaltung
shop_project_requirements_risk mögliches Risiko einer Anforderung in der Projektverwaltung
shop_project_requirements_stability mögliche Stabilität einer Anforderung in der Projektverwaltung
shop_project_requirements_type Liste möglicher Typen einer Anforderung in der Projektverwaltung
shop_project_timestate Liste möglicher Stati von Zeitbuchungen in der Projektverwaltung
shop_project_budget_type Liste möglicher Typen eines Budgets in der Projektverwaltung
shop_project_incominginvoice_appointment_state Liste möglicher Stati von Eingangsrechnungen in der Projektverwaltung
shop_project_incominginvoice_state Liste möglicher Stati zur Filterung von Eingangsrechnungen in der Projektverwaltung
shop_project_job_progress Liste möglicher Bearbeitungsstände in Prozent von Jobs in der Projektverwaltung
shop_project_job_type Liste möglicher Typen eines Jobs in der Projektverwaltung
shop_project_job_via Liste möglicher Arten der Auftragserteilung in der Projektverwaltung
shop_project_priority mögliche Priorität eines Projektes in der Projektverwaltung
shop_project_state Liste möglicher Stati eines Projektes in der Projektverwaltung
shop_shoppingcard_delivery_type Liste der zur Verfügung stehenden Adresstypen für Lieferungen
shop_store_update Liste möglicher Gründe einer Lagerbestandsbuchung
shop_turnover_quality_state Liste möglicher Stati einer Retourenposition
shop_turnover_retoure_action Liste der zur Verfügung stehenden Aktionen einer Retoure
shop_turnover_retoure_reason Liste der möglichen Retourengründe
shop_turnover_retoure_state Liste möglicher Stati einer Retoure
shop_turnover_retoure_zalando_reason Liste der möglichen Retourengründe einer Zalando Rücksendung
shop_turnover_type Liste möglicher Typen eines Wareneinganges
shop_voucher_state Liste möglicher Stati eines Gutscheines
shop_voucher_type Liste möglicher Einschränkungs-Typen eines Gutscheines
shop_voucher_unit Liste der Einheiten eines Gutscheines
zalando_de_errormessages Liste der Fehlermeldungen der Zalando API
zalando_de_material Mappingliste für Materialangaben bei Zalando

Werte einer Liste holen

Die Schlüssel-/Wertpaare einer Liste können über einen GET-Request über die URL /api/util/list/<name_der_liste> geladen werden. Das Ergebnis wird als Dataset zurückgeliefert.

{
    "dataset": {
        "1": "value 1",
        "2": "value 2",
        "3": "value 3",
    },
    "sys": {
        "pagination": {
            "total": 3
        },
        "message": "200 OK",
        "code": 200
    }
}

Konfiguration der Route

Über die Pfade werden die Speicherorte der Listen für die Defaultliste und für evtl. projektbezogene Listen definiert. Über die Blacklist-Tags, werden Listen, die über die API nicht ausgeliefert werden dürfen konfiguriert.

<route id="ALVINE-API-UTIL-LIST-GET">
    <presenter>\Alvine\Application\Platform\Presenter\Api\Util\StandardList</presenter>
    <method>GET</method>
    <pattern><![CDATA[^/api/util/list/(?<name>[0-9a-zA-z]+)$]]></pattern>
    <template><![CDATA[/api/util/list/${name}]]></template>
    <parameters>
        <parameter name="name" type='string'></parameter>
    </parameters>
    <configuration>
        <source>
            <standard>${legacy-basepath}alvine/plugin/lists/standard/${parameter-name}.inc.php</standard>
            <project>${legacy-basepath}alvine/plugin/lists/project/${parameter-name}.inc.php</project>
        </source>
        <blacklist>
            <name>content_shorturl_name</name>
            <name>content_rte_table_class</name>
        </blacklist>
    </configuration>
</route>

Projektliste schreiben

Standardlisten können für ein Projekt mit eigenen Werten überschrieben werden. Hierzu muss ein PUT-Request mit der neuen Liste an die URL /api/util/list/<name_der_liste> gesendet werden.

Wichtig

Überschriebene Listen können Ihr System unbrauchbar machen.

Der Aufbau der Liste ist ein einfaches JSON-Objekt mit Schlüssel-/Wert-Paaren.

{
    "1": "my value 1",
    "2": "my value 2",
    "3": "my value 3",
    "4": "my value 4"
}

Konfiguration der Route

Über die Pfade werden die Speicherorte der Listen für die Defaultliste und für evtl. projektbezogene Listen definiert. Über die Blacklist-Tags, werden Listen, die nicht überschrieben werden dürfen konfiguriert.

<route id="ALVINE-API-UTIL-LIST-PUT">
    <presenter>\Alvine\Application\Platform\Presenter\Api\Util\StandardList</presenter>
    <method>PUT</method>
    <pattern><![CDATA[^/api/util/list/(?<name>[0-9a-zA-z]+)$]]></pattern>
    <template><![CDATA[/api/util/list/${name}]]></template>
    <parameters>
        <parameter name="name" type='string'></parameter>
    </parameters>
    <configuration>
        <source>
            <standard>${legacy-basepath}alvine/plugin/lists/standard/${parameter-name}.inc.php</standard>
            <project>${legacy-basepath}alvine/plugin/lists/project/${parameter-name}.inc.php</project>
        </source>
        <blacklist>
            <name>content_shorturl_name</name>
            <name>content_rte_table_class</name>
        </blacklist>
    </configuration>
</route>

Projektliste löschen

Soll wieder die Standardliste verwendet werden, so kann die Projektliste über einen DELETE-Request mit der URL /api/util/list/<name_der_liste> gelöscht werden.

Wichtig

Das Löschen einer Projekliste kann bestehende Datensätze unbrauchbar machen.

Konfiguration der Route

Über die Pfade werden die Speicherorte der Listen für die Defaultliste und für evtl. projektbezogene Listen definiert.

<route id="ALVINE-API-UTIL-LIST-DELTE">
    <presenter>\Alvine\Application\Platform\Presenter\Api\Util\StandardList</presenter>
    <method>DELETE</method>
    <pattern><![CDATA[^/api/util/list/(?<name>[0-9a-zA-z]+)$]]></pattern>
    <template><![CDATA[/api/util/list/${name}]]></template>
    <parameters>
        <parameter name="name" type='string'></parameter>
    </parameters>
    <configuration>
        <source>
            <standard>${legacy-basepath}alvine/plugin/lists/standard/${parameter-name}.inc.php</standard>
            <project>${legacy-basepath}alvine/plugin/lists/project/${parameter-name}.inc.php</project>
        </source>
    </configuration>
</route>