Gruppe und Untergruppen abrufen
GET
/pimapi/v1/classifications/{classificationId}/groups/{classificationGroupId}Ruft die Eigenschaften einer bestimmten Klassifikationsgruppe ab, optional mit rekursivem Laden ihrer untergeordneten Klassifikationsgruppen bis zu einer bestimmten Tiefe.
Pfadparameter
Abschnitt betitelt „Pfadparameter“| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
classificationId | string | Ja | Eindeutige ID des Klassifikationssystems (z. B. ECLASS_10). |
classificationGroupId | string | Ja | ID der Klassifikationsgruppe (z. B. FASTENERS). |
Abfrageparameter (Query-Parameter)
Abschnitt betitelt „Abfrageparameter (Query-Parameter)“| Parameter | Typ | Erforderlich | Standardwert | Beschreibung |
|---|---|---|---|---|
levels | integer | Nein | Bestimmt die Tiefe der zu ladenden Untergruppen: • Null (weggelassen): Nur Details der angegebenen Gruppe. • 0: Lädt alle Ebenen der verschachtelten untergeordneten Untergruppen.• 1 oder höher: Lädt untergeordnete Untergruppen bis zur angegebenen Tiefe. | |
languageId | string | Nein | Sprachkürzel zur Lokalisierung von Beschreibungen (z. B. en, de). |
Code-Beispiele
Abschnitt betitelt „Code-Beispiele“curl -X GET "https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/classifications/ECLASS_10/groups/FASTENERS?levels=0&languageId=de" \ -H "X-API-KEY: ihr_hex_api_schluessel" \ -H "Accept: application/json"const headers = new Headers();headers.append("X-API-KEY", "ihr_hex_api_schluessel");headers.append("Accept", "application/json");
fetch("https://dev.pxm.eu.prodexa.com/pxm/pimapi/v1/classifications/ECLASS_10/groups/FASTENERS?levels=0&languageId=de", { method: 'GET', headers: headers}) .then(response => response.json()) .then(result => console.log(result)) .catch(error => console.log('error', error));Antwortstruktur
Abschnitt betitelt „Antwortstruktur“HTTP 200 OK Antwort
Abschnitt betitelt „HTTP 200 OK Antwort“Gibt ein Wrapper-Objekt zurück, bei dem data die angeforderte Gruppe und ihre rekursiv verschachtelten Untergruppen enthält.
{ "status": 200, "meta": { "languageId": "de" }, "data": [ { "classificationGroupId": "FASTENERS", "shortDescription": [ { "languageId": "de", "value": "Verbindungselemente" } ], "fallbackDescShort": [ { "languageId": "de", "value": "Verbindungselemente" } ], "longDescriptions": [ { "languageId": "de", "value": "Alle Arten von industriellen Verbindungselementen" } ], "documentUrl1": null, "documentUrl2": null, "documentUrl3": null, "orderNo": 1, "statusID": "ACTIVE", "attributes": [], "createdOn": "2026-06-15T09:00:00Z", "createdBy": "admin", "changedOn": "2026-06-15T09:00:00Z", "changedBy": "admin" }, { "classificationGroupId": "SCREWS", "parentClassificationGroupId": "FASTENERS", "shortDescription": [ { "languageId": "de", "value": "Schrauben" } ], "fallbackDescShort": [ { "languageId": "de", "value": "Schrauben" } ], "longDescriptions": [ { "languageId": "de", "value": "Gewindeschrauben aus Metall und Verbindungselemente" } ], "documentUrl1": null, "documentUrl2": null, "documentUrl3": null, "orderNo": 10, "statusID": "ACTIVE", "attributes": [ { "attributeId": "THREAD_SIZE", "attribute.description": [ { "languageId": "de", "value": "Gewindegröße" } ] } ], "createdOn": "2026-06-15T09:00:00Z", "createdBy": "admin", "changedOn": "2026-06-17T11:00:00Z", "changedBy": "admin" } ]}HTTP 404 Not Found Antwort
Abschnitt betitelt „HTTP 404 Not Found Antwort“Wird zurückgegeben, wenn die Gruppe innerhalb des angegebenen Klassifikationssystems nicht existiert.
{ "status": 404, "meta": { "languageId": "de" }, "error": "No Classification group [FASTENERS] found within classification [ECLASS_10]"}