fetchEpaBoms

Navigation:  WebService Calls > Options for Growth >

fetchEpaBoms

Previous pageReturn to chapter overviewNext page

Texte ein-/ausblenden

Beschreibung

Abfrage von Parts Stücklisten, damit die Artikel und die zugeordneten Baugruppen ermitteln kann.

Beispiel Request

Code

Feldliste Request

Name

Beschreibung

Anz.

Typ

Sonstiges

request

Root-Element der Anfrage

1

Element


method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchEpaBoms“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

filter

Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt.

1..N

Element


mandator_id

Schränkt die Ergebnismenge der Abfrage auf einen bestimmten Mandanten ein.

1

Element


filter_method

Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest.

1

string

Fester Wert:„=“

filter_value

Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest.

1

integer


bom_id

Schränkt die Ergebnismenge der Abfrage auf eine bestimmte Stückliste ein.

0..1

Element


filter_method

Attribut von bom_id. Legt das Verhalten des Stücklisten-Filters fest

1

string

Fester Wert:„=“

filter_value

Attribut von bom_id. Legt den Filterwert des Stücklisten-Filters fest.

1

integer


item_id

Schränkt die Ergebnismenge der Abfrage auf einen bestimmten Artikel ein.

0..1

Element


filter_method

Attribut von item_id. Legt das Verhalten des Artikel-Filters fest

1

string

Fester Wert:„=“

filter_value

Attribut von item_id. Legt den Filterwert des Artikel-Filters fest.

1

integer


assembly_id

Schränkt die Ergebnismenge der Abfrage auf eine bestimmte Baugruppe ein.

0..1

Element


filter_method

Attribut von assembly_id. Legt das Verhalten des Baugruppen-Filters fest.

1

string

Fester Wert:„=“

filter_value

Attribut von assembly_id. Legt den Filterwert des Baugruppen-Filters fest.

1

integer


provider_id

Schränkt die Ergebnismenge der Abfrage auf einen bestimmten Anbieter ein.

0..1

Element


filter_method

Attribut von provider_id. Legt das Verhalten des Anbieter-Filters fest

1

string

Fester Wert:„=“

filter_value

Attribut von provider_id. Legt den Filterwert des Anbieter-Filters fest.

1

integer


identifier

Schränkt die Ergebnismenge der Abfrage auf eine bestimmte Artikelbezeichnung ein.

0..1

Element


filter_method

Attribut von identifier. Legt das Verhalten des Identifier-Filters fest.

1

string

Fester Wert:„=“

filter_value

Attribut von identifier. Legt den Filterwert des Identifier-Filters fest.

1

string


internal_item_number

Schränkt die Ergebnismenge der Abfrage auf eine bestimmte interne Artikelnummer ein.

0..1

Element


filter_method

Attribut von internal_item_number. Legt das Verhalten des internen Artikelnummern-Filters fest

1

string

Fester Wert:„=“

filter_value

Attribut von internal_item_number. Legt den Filterwert des internen Artikelnummern-Filters fest.

1

string


extenal_identifier

Schränkt die Ergebnismenge der Abfrage auf eine bestimmte Hersteller-Artikelnummer ein.

0..1

Element


filter_method

Attribut von external_identifier. Legt das Verhalten des Hersteller-Artikelnummer-Filters fest.

1

string

Fester Wert:„=“

filter_value

Attribut von external_identifier. Legt den Filterwert des Hersteller-Artikelnummer-Filters fest.

1

string


active

Schränkt die Ergebnismenge der Abfrage auf aktive Stücklisten ein.

0..1

Element


allow_null

Attribut von active. Legt fest, ob Null erlaubt ist und mit zurückgegeben wird.

1

boolean


filter_value

Attribut von active. Legt den Filterwert des Active-Filters fest.

1

boolean


Beispiel Response

Code

Feldliste Response

Name

Beschreibung        

Anz.

Typ

sonstiges

response

Root-Element der Antwort

1

Element


method

Attribut von response. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchEpaBoms“

version

Attribut von response. Legt die Version der Anfrage fest.

1

integer

Fester Wert: „1.0.0“

report

Information über die ausgeführte Operation.

1

Element


return_code

Attribut von report. Gibt an ob in der durchgeführten Operation Fehler aufgetreten sind.

1

integer

0 = OK.

< 0 = Fehler

error_description

Falls bei der Durchführung der Operation Fehler aufgetreten sind wird in error_description eine Fehlerbeschreibung zurück geliefert

0..1

string


total_number_of_pages

Gibt an, wie viele Seiten es insgesamt gibt.

0..1

integer


total_number_of_entries

Gibt an, wie viele Einträge es insgesamt zurückgegeben werden.

0..1

integer


reference_id

Referenz-ID

0

string


action

Ausführende Aktion

0

string

delete, insert oder update

bom

Wrapper-Element für die Stücklisten

0..N

Element


bom_id

Stücklisten-ID

1

integer


assembly_id

Baugruppen-ID

1

integer


item_id

Artikel-ID

1

integer


provider_id

Anbieter-ID

1

integer


active

Active-Flag

1

boolean


item

Wrapper-Element für die Artikel

0..1

Element


item_id

Artikel-ID

1

integer


mandator_id

Mandanten-ID

1

integer


identifier

Bezeichnung des Artikels

1

string


internal_item_number

Interne Artikelnummer

1

string


vendor_item_number

Verkäufer-Artikelnummer

0..1

string


match_code

Matchcode

0..1

string


ean_code

EANCode

0..1

string


variable_field

Variablenfeld

0..1

string


stock_count

Bestandsangabe

0..1

integer


assembly

Wrapper-Element für die Baugruppen

0..1

Element


mandator_id

Mandanten-ID

1

integer


assembly_id

Baugruppen-ID

1

integer


identifier

Bezeichnung der Baugruppe

0..1

string


external_identifier

Externe Bezeichnung der Baugruppe

1

string


severity

Gewichtung

0..1

decimal


additional_items

Wrapper-Element für ergänzende Artikel

0..1

Element


additional_item

Wrapper-Element für Daten eines ergänzenden Artikel

1..N

Element


item_id

Artikel-ID

1

integer


quantity

Mengenangabe

1

integer


bom_id

Stücklisten-ID

1

integer


additional_item_type

Typ des ergänzenden Artikels

1

string


media

Wrapper-Element für Medien

0..1

Element


assembly_media

Wrapper-Element für Baugruppen-Medien

1..N

Element


bom_id

Stücklisten-ID

1

integer


medium_id

Medium-ID

1

integer


medium

Wrapper für die Elemente eines Mediums

0..1

Element


medium_id

Medium-ID

1

integer


mandator_id

Mandanten-ID

1

integer


medium_identifier

Bezeichnung des Mediums

1

string


medium_category_id

Mediumskategorie-ID

0..1

integer


file_name

Dateiname des Mediums

0..1

string


file_extension

Dateierweiterung des Mediums

0..1

string


file_size

Dateigröße des Mediums

0..1

integer


url

URL des Mediums

0..1

string


language_code_iso

ISO-Code der die Sprache darstellt

0..1

string

z.B.  „de“

title

Titel des Mediums

0..1

string


description

Beschreibung des Mediums

0..1

string


uploaded_at

Zeitpunkt des Uploads eines Mediums

0..1

dateTime


bom_texts

Wrapper-Elemente für Stücklisten-Texte

0..1

Element


bom_text

Wrapper-Elemente für Daten eines Stücklisten-Textes

1..N

Element


bom_id

Stücklisten-ID

1

integer


text_id

Text-ID

1

integer


bom_text_id

Stücklisten-Text-ID

1

integer


text

Wrapper-Element für die Daten des Textes

0..1

Element


text_id

Text-Id

1

integer


identifier

Bezeichnung des Textes

1

string


text_type

Typ des Textes

1

string


multi_language_data

Wrapper-Element, das mehrsprachig vorhandene Daten zusammenfasst.

0..1

Element


language_data

Wrapper-Element welches die Daten einer Sprache zusammenfasst.

1..N

Element


text_id

Text-ID

1

integer


language_code_iso

ISO-Code der die Sprache darstellt

1

string

z.B.  „de“

text

Der Text an sich

1

string


bom_attributes

Wrapper-Element welches die Stücklisten-Attribute zusammenfasst.

0..1

Element


bom_attribute

Wrapper-Element welches die Daten eines Stücklisten-Attributes zusammenfasst

1..N

Element


bom_attribute_id

Stücklisten-Attributs-ID

1

integer


bom_id

Stücklisten-ID

1

integer


attribute_id

Attributs-ID

1

integer


attribute

Wrapper-Element welches die Daten eines Attributs zusammenfasst

0..1

Element


attribute_id

Attributs-ID

1

integer


identifier

Bezeichnung des Attributes

1

string


attribute_type

Typ des Attributes

1

string


bom_attribute_values

Wrapper-Element welches die Stücklisten-Attributswerte zusammenfasst.

0..1

Element


bom_attribute_value

Wrapper-Element welches die Daten eines Stücklisten-Attributswertes zusammenfasst

1..N

Element


bom_attribute_value_id

Stücklisten-Attributswert-ID

1

integer


bom_attribute_id

Stücklisten-Attribus-ID

1

integer


attribute_value_id

Attributswert-ID

0..1

integer


value

Wert des Stücklisten-Attributes

0..1

string


attribute_value

Wrapper-Element für die Daten des Attibutswertes

0..1

Element


attribute_value_id

Attributswert-ID

1

integer


attribute_id

Attributs-ID

1

integer


value

Wert des Attributs

0..1

string


bom_attribute_value_media

Wrapper-Element welches die Stücklisten-Attributswert-Medien zusammenfasst

0..1

Element


bom_attribute_value_medium

Wrapper-Element welches die Daten eines Stücklisten-Attributswerts-Medium zusammenfasst

1..N

Element


medium_id

Medium-ID

1

integer


attribute_value_id

Attributswert-ID

1

integer


medium

Wrapper für die Elemente eines Mediums

0..1

Element


medium_id

Medium-ID

1

integer


mandator_id

Mandanten-ID

1

integer


medium_identifier

Bezeichnung des Mediums

1

string


medium_category_id

Mediumskategorie-ID

0..1

integer


file_name

Dateiname des Mediums

0..1

string


file_extension

Dateierweiterung des Mediums

0..1

string


file_size

Dateigröße des Mediums

0..1

integer


url

URL des Mediums

0..1

sting


language_code_iso

ISO-Code der die Sprache darstellt

0..1

sting

z.B.  „de“

title

Titel des Mediums

0..1

string


description

Beschreibung des Mediums

0..1

string


uploaded_at

Zeitpunkt des Uploads eines Mediums

0..1

dateTime


multi_language_data

Wrapper-Element, das mehrsprachig vorhandene Daten zusammenfasst.

0..1

Element


language_data

Wrapper-Element welches die Daten einer Sprache zusammenfasst.

1..N

Element


attribute_value_id

Arttributswert-ID

1

integer


language_code_iso

ISO-Code der die Sprache darstellt

1

string

z.B.  „de“

identifier

Bezeichnung der Sprache

1

string


multi_language_data

Wrapper-Element, das mehrsprachig vorhandene Daten zusammenfasst.

0..1

Element


language_data

Wrapper-Element welches die Daten einer Sprache zusammenfasst.

1..N

Element


bom_attribute_value_id

Stücklisten-Attributswert-ID

1

integer


language_code_iso

ISO-Code der die Sprache darstellt

1

string

z.B.  „de“

identifier

Bezeichnung der Sprache

1

string


inherited_multi_language_data

Wrapper-Element, das geerbte mehrsprachig vorhandene Daten zusammenfasst.

0..1

Element


inherited_language_data

Wrapper-Element welches die Daten einer geerbten Sprache zusammenfasst.

1..N

Element


attribute_value_id

Attributswert-ID

1

integer


language_code_iso

ISO-Code der die Sprache darstellt

1

string

z.B.  „de“

identifier

Bezeichnung der Sprache

1

string


 

Änderungsübersicht

Version

Änderungsbeschreibung

3.5.27

Initiale Version