Windchill Service Parts REST-APIs
Windchill Service Parts bietet REST-APIs für den Zugriff auf Teilelisten, Teilelistenelemente und Illustrationsdaten. Die APIs stellen schreibgeschützte Informationen für Webdienste wie ThingWorx bereit. Sie können von jedem Client genutzt werden, der HTTP-Anforderungen ausgeben kann.
|
|
Eine Benutzeroberfläche für diese APIs wird nicht bereitgestellt.
|
• /v1/partslists: Gibt alle Teilelisten zurück, die den angegebenen Kriterien entsprechen
◦ Eingabe:
▪ select: Bestimmt die Eigenschaften (Attribute) der Teilelisten, die von der Abfrage zurückgegeben werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des PartsList-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Lassen Sie die Liste leer, damit die Standardliste an Eigenschaften zurückgegeben wird.
Dieser Parameter ist optional.
▪ filter: Definiert einen Filter für die Abfrage
Ein
OData-Filterkriterium in der Form
<propertyName> <operator> '<value>' [and | or | not]..., wobei
operatoreq oder
ne oder
le oder ein anderer
OData-Vergleichsoperator ist.
Beispiel: number eq '0000222341'.
Dieser Parameter ist optional.
▪ navigationCriteria: Fügt weitere Kontrollmöglichkeiten zur zurückgegebenen Liste der Teilelisten hinzu
Der Windchill Objekt-Identifier (OID) der Navigationskriterien oder der Name der Navigationskriterien oder JSON-Daten können in ein Navigationskriterium geparst werden.
Wenn das gesuchte Objekt nicht iteriert wird, ist es nicht notwendig, die Navigationskriterien anzugeben.
Wenn der Wert nicht angegeben ist, wird die neueste Version ausgewählt.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Teilelisten (PartsList-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}: Gibt eine Teileliste mit einer angegebenen ID zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Teilelisten angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des PartsList-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine einzelne Teileliste (PartsList-Objekt) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/items: Gibt alle Teilelistenelemente in einer angegebenen Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute) der Teilelistenelemente, die von der Abfrage zurückgegeben werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des PartsListItem-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
▪ filter: Definiert einen Filter für die Abfrage
Ein
OData-Filterkriterium in der Form
<propertyName> <operator> '<value>' [and | or | not]..., wobei
operatoreq oder
ne oder
le oder ein anderer
OData-Vergleichsoperator ist.
Beispiel: number eq '0000222341'.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Teilelistenelementen (PartsListItem-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/items/{partsListItemId}: Gibt ein Teilelistenelement mit einer bestimmten ID in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ partsListItemId: Gibt den Identifier des Teilelistenelements an
Da das Teilelistenelement ein untergeordnetes Element der Teileliste ist, ist der Identifier des untergeordneten Elements ausreichend.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute) des Teilelistenelements, das von der Abfrage zurückgegeben wird
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des PartsListItem-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder ein einzelnes Teilelistenelement (PartsListItem-Objekt) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/part: Gibt das mit einem bestimmten Teilelistenelement in einer bestimmten Teileliste verbunden Teil zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ partsListItemId: Gibt den Identifier des Teilelistenelements an
Da das Teilelistenelement ein untergeordnetes Element der Teileliste ist, ist der Identifier des untergeordneten Elements ausreichend.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute) des Teils, das von der Abfrage zurückgegeben wird
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder ein einzelnes Teileobjekt oder ein Fehlercode und eine Fehlermeldung
▪ Siehe Fehlercodes.
• /v1/partslists/{partsListId}/itemrelations: Gibt alle Elementbeziehungen (Austausch- und Ergänzungsteile) in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Austausch- und Ergänzungsteile angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute der PartsListItemSubstituteLink- und SupplementaryReplacementLink-Objekttypen einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
▪ navigationCriteria: Fügt weitere Kontrollmöglichkeiten zur zurückgegebenen Liste der Austausch- und Ergänzungsteile hinzu
Der Windchill Objekt-Identifier (OID) der Navigationskriterien oder der Name der Navigationskriterien oder JSON-Daten können in ein Navigationskriterium geparst werden.
Wenn das gesuchte Objekt nicht iteriert wird, ist es nicht notwendig, die Navigationskriterien anzugeben.
Wenn der Wert nicht angegeben ist, wird die neueste Version ausgewählt.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Austauschteilen (PartsListItemSubstituteLink-Objekte) und Ergänzungsteilen (SupplementaryReplacementLink-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations: Gibt alle Elementbeziehungen (Austausch- und Ergänzungsteile) für ein bestimmtes Teilelistenelement in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ partsListItemId: Gibt den Identifier des Teilelistenelements an
Da das Teilelistenelement ein untergeordnetes Element der Teileliste ist, ist der Identifier des untergeordneten Elements ausreichend.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Austausch- und Ergänzungsteile angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute der PartsListItemSubstituteLink- und SupplementaryReplacementLink-Objekttypen einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
▪ navigationCriteria: Fügt weitere Kontrollmöglichkeiten zur zurückgegebenen Liste der Austausch- und Ergänzungsteile hinzu
Der Windchill Objekt-Identifier (OID) der Navigationskriterien oder der Name der Navigationskriterien oder JSON-Daten können in ein Navigationskriterium geparst werden.
Wenn das gesuchte Objekt nicht iteriert wird, ist es nicht notwendig, die Navigationskriterien anzugeben.
Wenn der Wert nicht angegeben ist, wird die neueste Version ausgewählt.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Austauschteilen (PartsListItemSubstituteLink-Objekte) und Ergänzungsteilen (SupplementaryReplacementLink-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/itemrelations/substitute: Gibt alle Austauschteile in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Austauschteile angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des PartsListItemSubstituteLink-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
▪ filter: Definiert einen Filter für die Abfrage
Ein
OData-Filterkriterium in der Form
<propertyName> <operator> '<value>' [and | or | not]..., wobei
operatoreq oder
ne oder
le oder ein anderer
OData-Vergleichsoperator ist.
Beispiel: number eq '0000222341'.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Austauschteilen (PartsListItemSubstituteLink-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/substitute: Gibt alle Austauschteile für ein bestimmtes Teilelistenelement in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ partsListItemId: Gibt den Identifier des Teilelistenelements an
Da das Teilelistenelement ein untergeordnetes Element der Teileliste ist, ist der Identifier des untergeordneten Elements ausreichend.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Austauschteile angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des PartsListItemSubstituteLink-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Austauschteilen (PartsListItemSubstituteLink-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/itemrelations/supplementary: Gibt alle Ergänzungsteile in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Ergänzungsteile angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des SupplementaryReplacementLink-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
▪ filter: Definiert einen Filter für die Abfrage
Ein
OData-Filterkriterium in der Form
<propertyName> <operator> '<value>' [and | or | not]..., wobei
operatoreq oder
ne oder
le oder ein anderer
OData-Vergleichsoperator ist.
Beispiel: number eq '0000222341'.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Ergänzungsteilen (SupplementaryReplacementLink-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/supplementary: Gibt alle Ergänzungsteile für ein bestimmtes Teilelistenelement in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ partsListItemId: Gibt den Identifier des Teilelistenelements an
Da das Teilelistenelement ein untergeordnetes Element der Teileliste ist, ist der Identifier des untergeordneten Elements ausreichend.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Ergänzungsteile angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des SupplementaryReplacementLink-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
▪ navigationCriteria: Fügt weitere Kontrollmöglichkeiten zur zurückgegebenen Liste der Ergänzungsteile hinzu
Der Windchill Objekt-Identifier (OID) der Navigationskriterien oder der Name der Navigationskriterien oder JSON-Daten können in ein Navigationskriterium geparst werden.
Wenn das gesuchte Objekt nicht iteriert wird, ist es nicht notwendig, die Navigationskriterien anzugeben.
Wenn der Wert nicht angegeben ist, wird die neueste Version ausgewählt.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Ergänzungsteilen (SupplementaryReplacementLink-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/illustrations: Gibt alle Illustrationen in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebenen Illustrationen angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des DynamicDocument-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
▪ filter: Definiert einen Filter für die Abfrage
Ein
OData-Filterkriterium in der Form
<propertyName> <operator> '<value>' [and | or | not]..., wobei
operatoreq oder
ne oder
le oder ein anderer
OData-Vergleichsoperator ist.
Beispiel: number eq '0000222341'.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine Liste von Illustrationen (DynamicDocument-Objekte) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/illustrations/{illustrationId}: Gibt eine Illustration mit einer bestimmten ID in einer bestimmten Teileliste zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ illustrationId: Gibt den Identifier der Illustration an
Da die Illustration ein untergeordnetes Element der Teileliste ist, ist der Identifier des untergeordneten Elements ausreichend.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für die von der Abfrage zurückgegebene Illustration angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des DynamicDocument-Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder eine einzelne Illustration (DynamicDocument-Objekt) oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
• /v1/partslists/{partsListId}/illustrations/{illustrationId}/image: Gibt das mit einer bestimmten Illustration in einer bestimmten Teileliste verbundene Bild zurück
◦ Eingabe:
▪ partsListId: Gibt den Identifier einer Teileliste in einem Organisationskontext an
Der Wert muss im Format <organizationName><delimiter><number> angegeben sein, beispielsweise Demo Organization_0000222341.
Dieser Parameter ist erforderlich.
▪ illustrationId: Gibt den Identifier der Illustration an
Da die Illustration ein untergeordnetes Element der Teileliste ist, ist der Identifier des untergeordneten Elements ausreichend.
Dieser Parameter ist erforderlich.
▪ select: Bestimmt die Eigenschaften (Attribute), die für das von der Abfrage zurückgegebene Bild angezeigt werden
Ein
OData-Auswahlausdruck, der eine kommagetrennte Liste von Eigenschaftennamen ist. Ein Eigenschaftenname muss der interne Name der Eigenschaft sein, wie er im
Windchill Tool zur Typ- und Attributverwaltung für den Objekttyp angezeigt wird.
Geben Sie ein Sternchen (*) an, um alle Attribute des Objekttyps einzuschließen, wie sie im Windchill Tool zur Typ- und Attributverwaltung definiert sind.
Dieser Parameter ist optional.
◦ Ausgabe:
▪ Entweder ein einzelnes Bildobjekt oder ein Fehlercode und eine Fehlermeldung
Siehe Fehlercodes.
Fehlercodes
Diese Tabelle beschreibt die Fehlercodes und -meldungen, die beim Ausführen dieser Dienste angezeigt werden können.
|
Code
|
Beschreibung
|
|
200
|
Erfolgreiche Antwort
|
|
400
|
URL oder Abfrageparameter falsch formatiert
|
|
404
|
Angegebenes Objekt existiert nicht
|
|
500
|
Unerwarteter Fehler
|
