API de REST de Windchill Service Parts
Windchill Service Parts proporciona las API de REST para acceder a la lista de artículos, el elemento de lista de artículos y los datos de ilustración. Las API exponen la información de solo lectura a los servicios Web como ThingWorx. Las puede utilizar cualquier cliente que sea capaz de realizar una solicitud HTTP.
|
|
No se proporciona una interfaz de usuario para estas API.
|
• /v1/partslists: permite devolver todas las listas de artículos que coinciden con los criterios especificados.
◦ Entrada:
▪ select: permite determinar las propiedades (atributos) de las listas de artículos que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto de la lista de artículos según se haya definido en el Administrador de tipos y atributos de Windchill.
Deje la lista vacía para devolver la lista por defecto de propiedades.
Este parámetro es opcional.
▪ filter: permite definir un filtro para la consulta.
Un criterio de filtro
OData en el formulario
<propertyName> <operator> '<value>' [and | or | not]..., donde
operator es
eq o
ne o
le u otros operadores de comparación
OData.
Por ejemplo, number eq '0000222341'.
Este parámetro es opcional.
▪ navigationCriteria: permite añadir control adicional a la lista de listas de artículos que se devuelve.
El identificador de objeto (OID) Windchill de los criterios de navegación o del nombre de criterios de navegación o JSON que se puede analizar en los criterios de navegación.
Si no se iterara el objeto buscado, no es necesario especificar los criterios de navegación.
Si no se especifica el valor, se elige la versión más reciente.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de listas de artículos (objetos de la lista de artículos) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}: permite devolver una lista de artículos con un ID especificado.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para la lista de artículos devuelta por la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto de la lista de artículos según se haya definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de artículos único (objeto de la lista de artículos) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/items: permite devolver todos los elementos de lista de artículos de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) de los elementos de las listas de artículos que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto PartsListItem según se haya definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
▪ filter: permite definir un filtro para la consulta.
Un criterio de filtro
OData en el formulario
<propertyName> <operator> '<value>' [and | or | not]..., donde
operator es
eq o
ne o
le u otros operadores de comparación
OData.
Por ejemplo, number eq '0000222341'.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de elementos de lista de artículos (objetos PartsListItem) o un código de error y un mensaje de error
Consulte Códigos de error.
• /v1/partslists/{partsListId}/items/{partsListItemId}: permite devolver un elemento de lista de artículos con un ID especificado de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ partsListItemId: permite especificar el identificador del elemento de la lista de artículos.
Cuando el elemento de la lista de artículos es un descendiente de la lista de artículos, el identificador descendiente es suficiente.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) del elemento de las listas de artículos que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto PartsListItem según se haya definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
◦ Salida:
▪ Un elemento de una lista de artículos únicos (objeto PartsListItem) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/items/{partsListItemId}/part: permite devolver el artículo asociado con un elemento de lista de artículos especificado de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ partsListItemId: permite especificar el identificador del elemento de la lista de artículos.
Cuando el elemento de la lista de artículos es un descendiente de la lista de artículos, el identificador descendiente es suficiente.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) del artículo devuelto por la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto según se haya definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
◦ Salida:
▪ Un objeto de artículo único o un código de error y un mensaje de error.
▪ Consulte Códigos de error.
• /v1/partslists/{partsListId}/itemrelations: permite devolver todas las relaciones del elemento (artículos de sustitutos y complementarios) de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para los artículos sustitutos y complementarios que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de los tipos de objeto PartsListItemSubstituteLink y SupplementaryReplacementLink según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
▪ navigationCriteria: permite añadir control adicional a la lista de artículos sustitutos y complementarios que se devuelve.
El identificador de objeto (OID) Windchill de los criterios de navegación o del nombre de criterios de navegación o JSON que se puede analizar en los criterios de navegación.
Si no se iterara el objeto buscado, no es necesario especificar los criterios de navegación.
Si no se especifica el valor, se elige la versión más reciente.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de artículos sustitutos (objetos PartsListItemSubstituteLink) y artículos complementarios (objetos SupplementaryReplacementLink) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations: permite devolver todas las relaciones del elemento (artículos sustitutos y complementarios) para un elemento de lista de artículos especificado de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ partsListItemId: permite especificar el identificador del elemento de la lista de artículos.
Cuando el elemento de la lista de artículos es un descendiente de la lista de artículos, el identificador descendiente es suficiente.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para los artículos sustitutos y complementarios que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de los tipos de objeto PartsListItemSubstituteLink y SupplementaryReplacementLink según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
▪ navigationCriteria: permite añadir control adicional a la lista de artículos sustitutos y complementarios que se devuelve.
El identificador de objeto (OID) Windchill de los criterios de navegación o del nombre de criterios de navegación o JSON que se puede analizar en los criterios de navegación.
Si no se iterara el objeto buscado, no es necesario especificar los criterios de navegación.
Si no se especifica el valor, se elige la versión más reciente.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de artículos sustitutos (objetos PartsListItemSubstituteLink) y artículos complementarios (objetos SupplementaryReplacementLink) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/itemrelations/substitute: permite devolver todos los artículos sustitutos de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para los artículos sustitutos que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto PartsListItemSubstituteLink según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
▪ filter: permite definir un filtro para la consulta.
Un criterio de filtro
OData en el formulario
<propertyName> <operator> '<value>' [and | or | not]..., donde
operator es
eq o
ne o
le u otros operadores de comparación
OData.
Por ejemplo, number eq '0000222341'.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de artículos sustitutos (objetos PartsListItemSubstituteLink) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/substitute: permite devolver todos los artículos sustitutos para un elemento de lista de artículos especificado de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ partsListItemId: permite especificar el identificador del elemento de la lista de artículos.
Cuando el elemento de la lista de artículos es un descendiente de la lista de artículos, el identificador descendiente es suficiente.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para los artículos sustitutos que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto PartsListItemSubstituteLink según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de artículos sustitutos (objetos PartsListItemSubstituteLink) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/itemrelations/supplementary: permite devolver todos los artículos complementarios de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para los artículos complementarios que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto SupplementaryReplacementLink según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
▪ filter: permite definir un filtro para la consulta.
Un criterio de filtro
OData en el formulario
<propertyName> <operator> '<value>' [and | or | not]..., donde
operator es
eq o
ne o
le u otros operadores de comparación
OData.
Por ejemplo, number eq '0000222341'.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de artículos complementarios (objetos SupplementaryReplacementLink) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/items/{partsListItemId}/itemrelations/supplementary: permite devolver todos los artículos complementarios para un elemento de lista de artículos especificado de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ partsListItemId: permite especificar el identificador del elemento de la lista de artículos.
Cuando el elemento de la lista de artículos es un descendiente de la lista de artículos, el identificador descendiente es suficiente.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para los artículos complementarios que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto SupplementaryReplacementLink según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
▪ navigationCriteria: permite añadir control adicional a la lista de artículos complementarios que se devuelve.
El identificador de objeto (OID) Windchill de los criterios de navegación o del nombre de criterios de navegación o JSON que se puede analizar en los criterios de navegación.
Si no se iterara el objeto buscado, no es necesario especificar los criterios de navegación.
Si no se especifica el valor, se elige la versión más reciente.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de artículos complementarios (objetos SupplementaryReplacementLink) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/illustrations: permite devolver todas las ilustraciones de una lista de artículos especificada
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para las ilustraciones que devuelve la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto DynamicDocument según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
▪ filter: permite definir un filtro para la consulta.
Un criterio de filtro
OData en el formulario
<propertyName> <operator> '<value>' [and | or | not]..., donde
operator es
eq o
ne o
le u otros operadores de comparación
OData.
Por ejemplo, number eq '0000222341'.
Este parámetro es opcional.
◦ Salida:
▪ Una lista de listas de ilustraciones (objetos DynamicDocument) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/illustrations/{illustrationId}: permite devolver una ilustración con un ID especificado de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ illustrationId: permite especificar el identificador de la ilustración.
Cuando la ilustración es un descendiente de la lista de artículos, el identificador descendiente es suficiente.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para la ilustración devuelta por la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto DynamicDocument según se hayan definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
◦ Salida:
▪ Una ilustración única (objeto DynamicDocument) o un código de error y un mensaje de error.
Consulte Códigos de error.
• /v1/partslists/{partsListId}/illustrations/{illustrationId}/image: permite devolver la imagen asociada a una ilustración especificada de una lista de artículos especificada.
◦ Entrada:
▪ partsListId: permite especificar el identificador de la lista de artículos en un contexto de organización
El valor debe estar en el formato <organizationName><delimiter><number>, por ejemplo Demo Organization_0000222341.
Este parámetro es obligatorio.
▪ illustrationId: permite especificar el identificador de la ilustración.
Cuando la ilustración es un descendiente de la lista de artículos, el identificador descendiente es suficiente.
Este parámetro es obligatorio.
▪ select: permite determinar las propiedades (atributos) que se muestran para la imagen devuelta por la consulta.
Una expresión de selección
OData que es una lista separada por comas de nombres de propiedades. Un nombre de la propiedad debe ser el nombre interno de la propiedad tal como aparece en el Administrador de tipos y atributos de
Windchill para el tipo de objeto.
Especifique un asterisco (*) para incluir todos los atributos de tipo de objeto según se haya definido en el Administrador de tipos y atributos de Windchill.
Este parámetro es opcional.
◦ Salida:
▪ Un objeto de imagen única o un código de error y un mensaje de error.
Consulte Códigos de error.
Códigos de error
En esta tabla se describen los códigos y mensajes de error que se pueden encontrar al ejecutar estos servicios.
|
Código
|
Descripción
|
|
200
|
Respuesta correcta
|
|
400
|
Los parámetros de URL o de la consulta se han formateado incorrectamente
|
|
404
|
El objeto especificado no existe
|
|
500
|
Error inesperado
|
