API REST pour les relations d'article
Windchill fournit des API REST permettant d'accéder aux relations d'article. 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.
 |
Notez les points suivants :
• Aucune interface utilisateur pour ces API n'est fournie.
• L'identificateur d'objet (OID) Windchill est utilisé dans de nombreuses définitions.
|
• /v1/partsrelations : retourne l'ensemble des objets de remplacement et des objets alternatifs qui correspondent aux critères spécifiés.
◦ Entrée :
▪ source : expression source Windchill qui représente une liste de noms d'identificateur OID séparés par une virgule.
▪ target : expression cible Windchill qui représente une liste de noms d'identificateur OID séparés par une virgule.
▪ type : expression de type Windchill qui représente une liste de noms de type séparés par une virgule.
▪ select : expression de sélection OData qui représente une liste de noms de propriété séparés par une virgule. Un service peut définir la liste par défaut des attributs à retourner. Si un astérisque (*) est spécifié, la liste de retour inclut tous les attributs de l'objet tels qu'ils sont définis dans l'utilitaire Gestion d'attributs et de types de Windchill.
▪ securityContext : identificateur OID Windchill du contexte de sécurité, du nom de contexte de sécurité ou JSON pouvant ê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 le contexte de sécurité. Si ce contexte n'est pas spécifié, la dernière version est alors choisie.
◦ Sortie :
▪ Liste d'articles ou code et message d'erreur.
• /v1/partsrelations/alternates : retourne l'ensemble des objets alternatifs qui correspondent aux critères spécifiés.
◦ Entrée :
▪ source : expression source Windchill qui représente une liste de noms d'identificateur OID séparés par une virgule.
▪ target : expression cible Windchill qui représente une liste de noms d'identificateur OID séparés par une virgule.
▪ select : expression de sélection OData qui représente une liste de noms de propriété séparés par une virgule. Un service peut définir la liste par défaut des attributs à retourner. Si un astérisque (*) est spécifié, la liste de retour inclut tous les attributs de l'objet tels qu'ils sont définis dans l'utilitaire Gestion d'attributs et de types de Windchill.
▪ securityContext : identificateur OID Windchill du contexte de sécurité, du nom de contexte de sécurité ou JSON pouvant ê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 le contexte de sécurité. Si ce contexte n'est pas spécifié, la dernière version est alors choisie.
◦ Sortie :
▪ Liste d'articles ou code et message d'erreur.
• /v1/partsrelations/supersession : retourne l'ensemble des objets de remplacement qui correspondent aux critères spécifiés.
◦ Entrée :
▪ source : expression source Windchill qui représente une liste de noms d'identificateur OID séparés par une virgule.
▪ target : expression cible Windchill qui représente une liste de noms d'identificateur OID séparés par une virgule.
▪ select : expression de sélection OData qui représente une liste de noms de propriété séparés par une virgule. Un service peut définir la liste par défaut des attributs à retourner. Si un astérisque (*) est spécifié, la liste de retour inclut tous les attributs de l'objet tels qu'ils sont définis dans l'utilitaire Gestion d'attributs et de types de Windchill.
▪ securityContext : identificateur OID Windchill du contexte de sécurité, du nom de contexte de sécurité ou JSON pouvant ê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 le contexte de sécurité. Si ce contexte n'est pas spécifié, la dernière version est alors choisie.
◦ Sortie :
▪ Liste d'articles ou code et message d'erreur.
• /v1/partsrelations/alternate/{id} : retourne l'objet alternatif dont l'ID est spécifié.
◦ Entrée :
▪ id : partie du numéro Windchill d'une règle d'initialisation d'un objet.
Ce paramètre est obligatoire.
▪ select : expression de sélection OData qui représente une liste de noms de propriété séparés par une virgule. Un service peut définir la liste par défaut des attributs à retourner. Si un astérisque (*) est spécifié, la liste de retour inclut tous les attributs de l'objet tels qu'ils sont définis dans l'utilitaire Gestion d'attributs et de types de Windchill.
◦ Sortie :
▪ Objet alternatif ou code et message d'erreur.
• /v1/partsrelations/supersession/{id} : retourne l'objet de remplacement dont l'ID est spécifié.
◦ Entrée :
▪ id : partie du numéro Windchill d'une règle d'initialisation d'un objet.
Ce paramètre est obligatoire.
▪ select : expression de sélection OData qui représente une liste de noms de propriété séparés par une virgule. Un service peut définir la liste par défaut des attributs à retourner. Si un astérisque (*) est spécifié, la liste de retour inclut tous les attributs de l'objet tels qu'ils sont définis dans l'utilitaire Gestion d'attributs et de types de Windchill.
◦ Sortie :
▪ Objet de remplacement ou code et message d'erreur.