API REST Windchill Service Parts
Windchill Service Parts fournit des API REST pour accéder à la liste d'articles, aux éléments de liste d'articles et aux données d'illustration. Les API exposent des informations en lecture seule aux services Web, par exemple ThingWorx. Elles peuvent être utilisées par tout client en mesure d'établir une requête HTTP.
|
|
Aucune interface utilisateur pour ces API n'est fournie.
|
• /v1/partslists : retourne toutes les listes d'articles qui correspondent aux critères spécifiés.
◦ Entrée :
▪ select : détermine les propriétés (attributs) des listes d'articles qui sont retournées par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet PartsList défini dans le Gestionnaire d'attributs et de types Windchill.
Laissez cette liste vide pour retourner la liste des propriétés par défaut.
Ce paramètre est facultatif.
▪ filter : définit un filtre pour la requête.
Critère de filtrage
OData sous la forme
<propertyName> <operator> '<value>' [and | or | not]..., où
operator représente
eqne ou
le, ou d'autres opérateurs de comparaison
OData.
Par exemple, number eq '0000222341'.
Ce paramètre est facultatif.
▪ navigationCriteria : renforce le contrôle sur la liste des listes d'articles retournée.
Identificateur d'objet (OID) Windchill des critères de navigation, nom de critère de navigation ou JSON qui peut être analysé en critère de navigation.
Si l'objet recherché n'est pas itéré, il n'est pas nécessaire de spécifier les critères de navigation.
Si cette valeur n'est pas spécifiée, la dernière version est alors choisie.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste de listes d'articles (objets PartsList) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId} : retourne une liste d'articles dont l'ID est spécifié.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour la liste d'articles retournée par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet PartsList défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'articles unique (objet PartsList) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/items : retourne tous les éléments de liste d'articles dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) des éléments de listes d'articles qui sont retournés par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet PartsListItem défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
▪ filter : définit un filtre pour la requête.
Critère de filtrage
OData sous la forme
<propertyName> <operator> '<value>' [and | or | not]..., où
operator représente
eqne ou
le, ou d'autres opérateurs de comparaison
OData.
Par exemple, number eq '0000222341'.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'éléments de liste d'articles (objets PartsListItem) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/items/{partsListItemId} : retourne un élément de liste d'articles dont l'ID est spécifié dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ partsListItemId : spécifie l'identificateur de l'élément de liste d'articles.
Comme l'élément de liste d'articles est un descendant de la liste d'articles, l'identificateur de descendant suffit.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) de l'élément de listes d'articles retourné par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet PartsListItem défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
◦ Sortie :
▪ Elément de liste d'articles (objet PartsListItem) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/items/{partsListItemId}/part : retourne l'article associé à un élément de liste d'articles spécifié dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ partsListItemId : spécifie l'identificateur de l'élément de liste d'articles.
Comme l'élément de liste d'articles est un descendant de la liste d'articles, l'identificateur de descendant suffit.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) de l'article retourné par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
◦ Sortie :
▪ Objet d'article unique ou code et message d'erreur.
▪ Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/itemrelations : retourne toutes les relations d'élément (articles supplémentaires et de substitution) dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour les articles supplémentaires et de substitution qui sont retournés par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs des types d'objet PartsListItemSubstituteLink et SupplementaryReplacementLink définis dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
▪ navigationCriteria : renforce le contrôle sur la liste des articles supplémentaires et de substitution retournée.
Identificateur d'objet (OID) Windchill des critères de navigation, nom de critère de navigation ou JSON qui peut être analysé en critère de navigation.
Si l'objet recherché n'est pas itéré, il n'est pas nécessaire de spécifier les critères de navigation.
Si cette valeur n'est pas spécifiée, la dernière version est alors choisie.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'articles de substitution (objets PartsListItemSubstituteLink) et d'articles supplémentaires (objets SupplementaryReplacementLink) ou code et message d'erreur
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations : retourne toutes les relations d'élément (articles supplémentaires et de substitution) d'un élément de liste d'articles spécifié dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ partsListItemId : spécifie l'identificateur de l'élément de liste d'articles.
Comme l'élément de liste d'articles est un descendant de la liste d'articles, l'identificateur de descendant suffit.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour les articles supplémentaires et de substitution qui sont retournés par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs des types d'objet PartsListItemSubstituteLink et SupplementaryReplacementLink définis dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
▪ navigationCriteria : renforce le contrôle sur la liste des articles supplémentaires et de substitution retournée.
Identificateur d'objet (OID) Windchill des critères de navigation, nom de critère de navigation ou JSON qui peut être analysé en critère de navigation.
Si l'objet recherché n'est pas itéré, il n'est pas nécessaire de spécifier les critères de navigation.
Si cette valeur n'est pas spécifiée, la dernière version est alors choisie.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'articles de substitution (objets PartsListItemSubstituteLink) et d'articles supplémentaires (objets SupplementaryReplacementLink) ou code et message d'erreur
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/itemrelations/substitute : retourne tous les articles de substitution dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour les articles de substitution qui sont retournés par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet PartsListItemSubstituteLink défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
▪ filter : définit un filtre pour la requête.
Critère de filtrage
OData sous la forme
<propertyName> <operator> '<value>' [and | or | not]..., où
operator représente
eqne ou
le, ou d'autres opérateurs de comparaison
OData.
Par exemple, number eq '0000222341'.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'articles de substitution (objets PartsListItemSubstituteLink) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/substitute : retourne tous les articles de substitution d'un élément de liste d'articles spécifié dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ partsListItemId : spécifie l'identificateur de l'élément de liste d'articles.
Comme l'élément de liste d'articles est un descendant de la liste d'articles, l'identificateur de descendant suffit.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour les articles de substitution qui sont retournés par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet PartsListItemSubstituteLink défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'articles de substitution (objets PartsListItemSubstituteLink) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/itemrelations/supplementary : retourne tous les articles supplémentaires dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour les articles supplémentaires qui sont retournés par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet SupplementaryReplacementLink défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
▪ filter : définit un filtre pour la requête.
Critère de filtrage
OData sous la forme
<propertyName> <operator> '<value>' [and | or | not]..., où
operator représente
eqne ou
le, ou d'autres opérateurs de comparaison
OData.
Par exemple, number eq '0000222341'.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'articles supplémentaires (objets SupplementaryReplacementLink) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/supplementary : retourne tous les articles supplémentaires d'un élément de liste d'articles spécifié dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ partsListItemId : spécifie l'identificateur de l'élément de liste d'articles.
Comme l'élément de liste d'articles est un descendant de la liste d'articles, l'identificateur de descendant suffit.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour les articles supplémentaires qui sont retournés par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet SupplementaryReplacementLink défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
▪ navigationCriteria : renforce le contrôle sur la liste d'articles supplémentaires retournée.
Identificateur d'objet (OID) Windchill des critères de navigation, nom de critère de navigation ou JSON qui peut être analysé en critère de navigation.
Si l'objet recherché n'est pas itéré, il n'est pas nécessaire de spécifier les critères de navigation.
Si cette valeur n'est pas spécifiée, la dernière version est alors choisie.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'articles supplémentaires (objets SupplementaryReplacementLink) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/illustrations : retourne toutes les illustrations dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour les illustrations qui sont retournées par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet DynamicDocument défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
▪ filter : définit un filtre pour la requête.
Critère de filtrage
OData sous la forme
<propertyName> <operator> '<value>' [and | or | not]..., où
operator représente
eqne ou
le, ou d'autres opérateurs de comparaison
OData.
Par exemple, number eq '0000222341'.
Ce paramètre est facultatif.
◦ Sortie :
▪ Liste d'illustrations (objets DynamicDocument) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/illustrations/{illustrationId} : retourne une illustration dont l'ID est spécifié dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ illustrationId : spécifie l'identificateur de l'illustration.
Comme l'illustration est un descendant de la liste d'articles, l'identificateur de descendant suffit.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour l'illustration retournée par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet DynamicDocument défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
◦ Sortie :
▪ Illustration unique (objet DynamicDocument) ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
• /v1/partslists/{partsListId}/illustrations/{illustrationId}/image : retourne l'image associée à une illustration spécifiée dans une liste d'articles spécifiée.
◦ Entrée :
▪ partsListId : spécifie l'identificateur de la liste d'articles dans un contexte d'organisation.
La valeur doit être au format <organizationName><delimiter><number>, par exemple Demo Organization_0000222341.
Ce paramètre est obligatoire.
▪ illustrationId : spécifie l'identificateur de l'illustration.
Comme l'illustration est un descendant de la liste d'articles, l'identificateur de descendant suffit.
Ce paramètre est obligatoire.
▪ select : détermine les propriétés (attributs) affichées pour l'image retournée par la requête.
Expression de sélection
OData qui représente une liste de noms de propriété séparés par une virgule. Un nom de propriété doit correspondre au nom interne de la propriété tel qu'il est affiché dans le Gestionnaire d'attributs et de types
Windchill pour le type d'objet.
Spécifiez un astérisque (*) pour inclure tous les attributs du type d'objet défini dans le Gestionnaire d'attributs et de types Windchill.
Ce paramètre est facultatif.
◦ Sortie :
▪ Objet d'image unique ou code et message d'erreur.
Consultez la rubrique Codes d'erreur.
Codes d'erreur
Ce tableau décrit les codes et le message d'erreur que vous pouvez rencontrer lorsque vous exécutez ces services.
|
Code
|
Description
|
|
200
|
Réponse positive
|
|
400
|
Mise en forme incorrecte de l'URL ou des paramètres de requête
|
|
404
|
Absence de l'objet spécifié
|
|
500
|
Erreur inattendue
|
