API REST Windchill Service Parts
Windchill Service Parts fornisce API REST per l'accesso ai dati di elenchi parti, elementi di elenchi parti e illustrazioni. Le API espongono informazioni di sola lettura a servizi Web come ThingWorx e possono essere utilizzate da qualsiasi client in grado di creare una richiesta HTTP.
|
|
Per queste API non è disponibile un'interfaccia utente.
|
• /v1/partslists - Restituisce tutti gli elenchi parti corrispondenti ai criteri specificati.
◦ Input:
▪ select - Determina le proprietà (attributi) degli elenchi parti restituiti dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto PartsList definiti in Gestione tipi e attributi di Windchill.
Lasciare l'elenco vuoto per restituire l'elenco di proprietà di default.
Questo parametro è facoltativo.
▪ filter - Definisce un filtro per l'interrogazione.
Criteri di filtro
OData nel formato
<propertyName> <operator> '<value>' [and | or | not]..., in cui
operator è
eq,
ne,
le o un altro operatore di confronto
OData.
Ad esempio, number eq '0000222341'.
Questo parametro è facoltativo.
▪ navigationCriteria - Aggiunge ulteriore controllo sull'elenco di elenchi parti restituito.
Identificatore oggetto (OID) di Windchill dei criteri di navigazione, nome dei criteri di navigazione o JSON analizzabile come criteri di navigazione.
Se l'oggetto cercato non è iterato, non è necessario specificare i criteri di navigazione.
Se il valore non è specificato, viene scelta la versione più recente.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di elenchi parti (oggetti PartsList) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId} - Restituisce un elenco parti con un ID specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per l'elenco parti restituito dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto PartsList definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
◦ Output:
▪ Singolo elenco parti (oggetto PartsList) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/items - Restituisce tutti gli elementi di un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) degli elementi dell'elenco parti restituiti dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto PartsListItem definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
▪ filter - Definisce un filtro per l'interrogazione.
Criteri di filtro
OData nel formato
<propertyName> <operator> '<value>' [and | or | not]..., in cui
operator è
eq,
ne,
le o un altro operatore di confronto
OData.
Ad esempio, number eq '0000222341'.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di elementi dell'elenco parti (oggetti PartsListItem) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/items/{partsListItemId} - Restituisce un elemento con un ID specificato di un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ partsListItemId - Specifica l'identificatore dell'elemento dell'elenco parti.
Poiché l'elemento è un discendente dell'elenco parti, è sufficiente l'identificatore di discendente.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) dell'elemento dell'elenco parti restituito dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto PartsListItem definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
◦ Output:
▪ Singolo elemento dell'elenco parti (oggetto PartsListItem) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/items/{partsListItemId}/part - Restituisce la parte associata a un elemento specificato di un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ partsListItemId - Specifica l'identificatore dell'elemento dell'elenco parti.
Poiché l'elemento è un discendente dell'elenco parti, è sufficiente l'identificatore di discendente.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) della parte restituita dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
◦ Output:
▪ Singolo oggetto parte oppure codice e messaggio di errore
▪ Vedere Codici di errore.
• /v1/partslists/{partsListId}/itemrelations - Restituisce tutte le relazioni di elementi (parti di sostituzione e supplementari) in un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per le parti di sostituzione e supplementari restituite dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi dei tipi di oggetto PartsListItemSubstituteLink e SupplementaryReplacementLink definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
▪ navigationCriteria - Aggiunge ulteriore controllo sull'elenco di parti supplementari e di sostituzione restituito.
Identificatore oggetto (OID) di Windchill dei criteri di navigazione, nome dei criteri di navigazione o JSON analizzabile come criteri di navigazione.
Se l'oggetto cercato non è iterato, non è necessario specificare i criteri di navigazione.
Se il valore non è specificato, viene scelta la versione più recente.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di parti di sostituzione (oggetti PartsListItemSubstituteLink) e parti supplementari (oggetti SupplementaryReplacementLink) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations - Restituisce tutte le relazioni di elementi (parti di sostituzione e supplementari) per un elemento specificato di un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ partsListItemId - Specifica l'identificatore dell'elemento dell'elenco parti.
Poiché l'elemento è un discendente dell'elenco parti, è sufficiente l'identificatore di discendente.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per le parti di sostituzione e supplementari restituite dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi dei tipi di oggetto PartsListItemSubstituteLink e SupplementaryReplacementLink definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
▪ navigationCriteria - Aggiunge ulteriore controllo sull'elenco di parti supplementari e di sostituzione restituito.
Identificatore oggetto (OID) di Windchill dei criteri di navigazione, nome dei criteri di navigazione o JSON analizzabile come criteri di navigazione.
Se l'oggetto cercato non è iterato, non è necessario specificare i criteri di navigazione.
Se il valore non è specificato, viene scelta la versione più recente.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di parti di sostituzione (oggetti PartsListItemSubstituteLink) e parti supplementari (oggetti SupplementaryReplacementLink) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/itemrelations/substitute - Restituisce tutte le parti di sostituzione in un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per le parti di sostituzione restituite dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto PartsListItemSubstituteLink definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
▪ filter - Definisce un filtro per l'interrogazione.
Criteri di filtro
OData nel formato
<propertyName> <operator> '<value>' [and | or | not]..., in cui
operator è
eq,
ne,
le o un altro operatore di confronto
OData.
Ad esempio, number eq '0000222341'.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di parti di sostituzione (oggetti PartsListItemSubstituteLink) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/substitute - Restituisce tutte parti di sostituzione per un elemento specificato di un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ partsListItemId - Specifica l'identificatore dell'elemento dell'elenco parti.
Poiché l'elemento è un discendente dell'elenco parti, è sufficiente l'identificatore di discendente.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per le parti di sostituzione restituite dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto PartsListItemSubstituteLink definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di parti di sostituzione (oggetti PartsListItemSubstituteLink) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/itemrelations/supplementary - Restituisce tutte le parti supplementari in un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per le parti supplementari restituite dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto SupplementaryReplacementLink definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
▪ filter - Definisce un filtro per l'interrogazione.
Criteri di filtro
OData nel formato
<propertyName> <operator> '<value>' [and | or | not]..., in cui
operator è
eq,
ne,
le o un altro operatore di confronto
OData.
Ad esempio, number eq '0000222341'.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di parti supplementari (oggetti SupplementaryReplacementLink) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/supplementary - Restituisce tutte parti supplementari per un elemento specificato di un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ partsListItemId - Specifica l'identificatore dell'elemento dell'elenco parti.
Poiché l'elemento è un discendente dell'elenco parti, è sufficiente l'identificatore di discendente.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per le parti supplementari restituite dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto SupplementaryReplacementLink definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
▪ navigationCriteria - Aggiunge ulteriore controllo sull'elenco parti supplementari restituito.
Identificatore oggetto (OID) di Windchill dei criteri di navigazione, nome dei criteri di navigazione o JSON analizzabile come criteri di navigazione.
Se l'oggetto cercato non è iterato, non è necessario specificare i criteri di navigazione.
Se il valore non è specificato, viene scelta la versione più recente.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di parti supplementari (oggetti SupplementaryReplacementLink) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/illustrations - Restituisce tutte le illustrazioni in un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per le illustrazioni restituite dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto DynamicDocument definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
▪ filter - Definisce un filtro per l'interrogazione.
Criteri di filtro
OData nel formato
<propertyName> <operator> '<value>' [and | or | not]..., in cui
operator è
eq,
ne,
le o un altro operatore di confronto
OData.
Ad esempio, number eq '0000222341'.
Questo parametro è facoltativo.
◦ Output:
▪ Elenco di illustrazioni (oggetti DynamicDocument) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/illustrations/{illustrationId} - Restituisce un'illustrazione con un ID specificato in un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ illustrationId - Specifica l'identificatore dell'illustrazione.
Poiché l'illustrazione è un discendente dell'elenco parti, è sufficiente l'identificatore di discendente.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per l'illustrazione restituita dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto DynamicDocument definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
◦ Output:
▪ Singola illustrazione (oggetto DynamicDocument) oppure codice e messaggio di errore
Vedere Codici di errore.
• /v1/partslists/{partsListId}/illustrations/{illustrationId}/image - Restituisce l'immagine associata a un'illustrazione specificata in un elenco parti specificato.
◦ Input:
▪ partsListId - Specifica l'identificatore dell'elenco parti in un contesto di organizzazione.
Il valore deve essere nel formato <organizationName><delimiter><number>, ad esempio Demo Organization_0000222341.
Questa parametro è obbligatorio.
▪ illustrationId - Specifica l'identificatore dell'illustrazione.
Poiché l'illustrazione è un discendente dell'elenco parti, è sufficiente l'identificatore di discendente.
Questa parametro è obbligatorio.
▪ select - Determina le proprietà (attributi) visualizzate per l'immagine restituita dall'interrogazione.
Espressione di selezione
OData costituita da un elenco separato da virgole di nomi di proprietà. Il nome di una proprietà deve essere il nome interno della proprietà visualizzato in Gestione tipi e attributi di
Windchill per il tipo di oggetto.
Specificare un asterisco (*) per includere tutti gli attributi del tipo di oggetto definiti in Gestione tipi e attributi di Windchill.
Questo parametro è facoltativo.
◦ Output:
▪ Singolo oggetto immagine oppure codice e messaggio di errore
Vedere Codici di errore.
Codici di errore
In questa tabella sono descritti i codici e i messaggi di errore che possono essere visualizzati durante l'esecuzione di questi servizi.
|
Codice
|
Descrizione
|
|
200
|
Risposta completata
|
|
400
|
URL o parametri dell'interrogazione in formato non corretto
|
|
404
|
L'oggetto specificato non esiste
|
|
500
|
Errore imprevisto
|
