Fuxsy-ADSKFusionManagePaid (publicador independiente) (versión preliminar)
Para obtener más información, visite: www.fuxsy.eu
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Fuxsy s.r.o. |
| URL | http://fuxsy.eu/ |
| Correo Electrónico | support@fuxsy.eu |
| Metadatos del conector | |
|---|---|
| Publicador | Fuxsy.eu |
| Website | http://fuxsy.eu/ |
| Directiva de privacidad | http://fuxsy.eu/ |
| Categorías | Data;IT Operations |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de fila de cuadrícula de elementos |
Actualiza una o varias filas de un elemento específico. |
| Campos de lista de elementos |
Recupera una lista de todos los campos de la cuadrícula. |
| Creación de elementos |
Crea un nuevo elemento dentro de un área de trabajo específica. |
| Creación de elementos administrados |
Asocia un nuevo elemento administrado a un elemento específico. |
| Crear carpeta de datos adjuntos |
Crea una nueva carpeta de datos adjuntos para un elemento específico. |
| Crear datos adjuntos |
Crea o carga un nuevo archivo adjunto para un elemento específico. |
| Crear elemento de relación de elemento |
Crea una nueva relación para un elemento específico. |
| Crear fila de elemento |
Crea una nueva fila para un elemento específico dentro de la cuadrícula. |
| Crear script nuevo |
Crea un nuevo script del tipo especificado. |
| Descarga de informes |
Recupera información detallada sobre un informe o descarga el informe |
| Detalle del elemento de relación de elemento V1 |
Recupera una lista de relaciones para un elemento específico. |
| Detalles de actualización de elementos |
Actualiza los detalles de un elemento específico, quitando los detalles que no se especifican. |
| Detalles de actualización de elementos: parcial |
Actualiza parcialmente los detalles de un elemento específico, conservando los detalles no especificados. |
| Detalles de grupos |
Recupera información detallada sobre un grupo específico. |
| Detalles de la lista de selección |
Recupera los detalles de las búsquedas de listas de selección. |
| Detalles de la vista de usuario |
Recupera información detallada sobre la vista de un usuario específico. |
| Detalles de los datos adjuntos |
Recupera información detallada sobre un archivo adjunto específico. |
| Detalles del campo de elemento |
Muestra información detallada sobre el campo especificado dentro de una cuadrícula de elementos. |
| Detalles del elemento |
Recupera información detallada sobre un elemento específico. |
| Detalles del informe |
Recupera los detalles de configuración completos del informe. |
| Detalles del permiso |
Recupera información detallada sobre un permiso específico. |
| Detalles del permiso de usuario |
Recupera los detalles del permiso para un usuario específico dentro de un área de trabajo específica, en función del identificador de permiso proporcionado. |
| Detalles del script |
Recupera el contenido y los detalles de un script específico. |
| Detalles del usuario |
Recupera información detallada sobre el usuario especificado. Si @me se usa, la API devolverá detalles sobre el usuario que realiza la llamada API. |
| Elemento donde se usa |
Recupera una lista de dónde se usa el elemento específico. |
| Elementos administrados de elementos |
Recupera una lista de elementos administrados asociados a un elemento específico. |
| Elementos del área de trabajo |
Recupera una lista de todos los elementos de un área de trabajo específica. |
| Filas de cuadrícula de elementos |
Recupera una lista de filas y campos de un elemento específico, incluidos sus valores. |
| Información general sobre la pestaña Elementos |
Recupera una lista de registros y campos de una pestaña específica. |
|
Item Print |
Genera una vista de impresión de un elemento específico. |
| Lista de campos de detalles del elemento |
Recupera una lista de todos los campos disponibles en la pestaña Detalles del elemento. |
| Lista de datos adjuntos |
Recupera una lista de todos los datos adjuntos de un elemento específico. |
| Lista de elementos administrados de elementos |
Recupera una lista de elementos administrados asociados a un elemento específico. |
| Lista de grupos |
Recupera una lista de todos los grupos disponibles en el inquilino. |
| Lista de permisos |
Recupera una lista de todos los permisos disponibles en el inquilino. |
| Lista de pestañas de elementos del área de trabajo |
Recupera una lista de todas las pestañas configuradas para un área de trabajo específica. |
| Lista de scripts |
Recupera una lista de todos los scripts del inquilino. |
| Lista de secciones de elementos |
Recupera una lista de todas las secciones de la pestaña Detalles del elemento. |
| Lista de usuarios |
Recupera una lista de todos los usuarios del inquilino con la opción de filtrar por estado. |
| Lista de usuarios de permisos |
Recupera una lista de todos los permisos asignados a un usuario específico. |
| Lista de vistas configuradas para áreas de trabajo |
Recupera una lista de todas las vistas configuradas para un área de trabajo específica. |
| Lista de áreas de trabajo |
Recupera una lista de todas las áreas de trabajo del inquilino. |
|
Lista print |
Recupera una lista de vistas de impresión disponibles. |
| Lista relaciones de elementos |
Recupera una lista de todos los elementos de relación asociados a un elemento específico. |
| Nivel de acceso basado en vistas de usuario |
Recupera una lista de todas las vistas de usuario (filtro realizado por el usuario de elementos dentro de un área de trabajo). |
| Registro de cambios de elemento |
Recupera información detallada sobre los cambios realizados en un elemento específico. |
| Registro de elementos |
Recupera información detallada del registro de un elemento específico. |
| Tipos de campo de elemento |
Proporciona una lista de todos los tipos de campo disponibles. |
| Trabajo pendiente del usuario |
Recupera el trabajo pendiente para el usuario que ha iniciado sesión a través de la API. El @me parámetro se usa para hacer referencia al usuario que ha iniciado sesión actualmente y no es posible elegir otro usuario. |
| Transiciones de lista de áreas de trabajo |
Recupera una lista de transiciones disponibles para un área de trabajo específica. |
| Transiciones disponibles |
Recupera una lista de transiciones disponibles para un elemento específico basado en el usuario que ha iniciado sesión. |
| Transición de elemento |
Realiza una transición en un elemento específico. Devuelve 403 incluso cuando se ejecuta correctamente. |
| Usuarios en grupo |
Recupera una lista de usuarios y sus detalles para un grupo específico. |
| Valor de búsqueda en todo el inquilino |
Busca un valor en todos los elementos del inquilino completo. |
| Versión de creación de datos adjuntos |
Crea una nueva versión de los datos adjuntos existentes. |
Actualización de fila de cuadrícula de elementos
Actualiza una o varias filas de un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que contiene la pestaña de cuadrícula.
|
ItemID | True | integer |
El identificador del elemento que contiene la pestaña de cuadrícula se puede obtener a través de la llamada a get Item List API. |
|
Especifica el identificador de la fila que se va a actualizar.
|
RowID | True | integer |
Identificador de la fila que desea actualizar. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Campos de lista de elementos
Recupera una lista de todos los campos de la cuadrícula.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para la recuperación de detalles del campo de cuadrícula.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles del campo de cuadrícula se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el tipo de medio esperado en la respuesta.
|
Accept | string |
Especifica el tipo de medio que el cliente espera en la respuesta. En este caso, el cliente solicita que la respuesta esté en formato JSON. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.fields.items.properties.__self__.type | string | |
|
defaultValue
|
properties.fields.items.properties.defaultValue | object | |
|
type
|
properties.fields.items.properties.derived.type | string | |
|
type
|
properties.fields.items.properties.description.type | string | |
|
type
|
properties.fields.items.properties.displayLength.type | string | |
|
type
|
properties.fields.items.properties.displayOrder.type | string | |
|
type
|
properties.fields.items.properties.editability.type | string | |
|
fieldLength
|
properties.fields.items.properties.fieldLength | object | |
|
fieldPrecision
|
properties.fields.items.properties.fieldPrecision | object | |
|
fieldValidators
|
properties.fields.items.properties.fieldValidators | object | |
|
type
|
properties.fields.items.properties.formulaField.type | string | |
|
Propiedades
|
properties.fields.items.properties.gridFieldAggregationInfo.properties | object | |
|
type
|
properties.fields.items.properties.gridFieldAggregationInfo.type | string | |
|
label
|
properties.fields.items.properties.label | object | |
|
type
|
properties.fields.items.properties.name.type | string | |
|
type
|
properties.fields.items.properties.picklist.type | string | |
|
type
|
properties.fields.items.properties.picklistFieldDefinition.type | string | |
|
type
|
properties.fields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.fields.items.properties.type.properties.link.type | string | |
|
type
|
properties.fields.items.properties.type.properties.title.type | string | |
|
type
|
properties.fields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.fields.items.properties.type.type | string | |
|
unidad de medida
|
properties.fields.items.properties.unitOfMeasure | object | |
|
type
|
properties.fields.items.properties.urn.type | string | |
|
validadores
|
properties.fields.items.properties.validators | object | |
|
type
|
properties.fields.items.properties.visibility.type | string | |
|
visibleOnPreview
|
properties.fields.items.properties.visibleOnPreview | object | |
|
required
|
properties.fields.items.required | array of string | |
|
type
|
properties.fields.items.type | string | |
|
type
|
properties.fields.type | string | |
|
type
|
type | string |
Creación de elementos
Crea un nuevo elemento dentro de un área de trabajo específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para la creación de elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo en la que desea crear un elemento, se puede obtener a través de la llamada a GET Workspace List API. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Creación de elementos administrados
Asocia un nuevo elemento administrado a un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que contiene la pestaña del elemento administrado.
|
ItemID | True | integer |
El identificador del elemento que contiene la pestaña del elemento administrado se puede obtener a través de la llamada a la API GET Item List. |
|
Especifica el tipo de medio esperado en la respuesta.
|
Accept | string |
Especifica el tipo de medio que el cliente espera en la respuesta. En este caso, el cliente solicita que la respuesta esté en formato de datos de elementos afectados masivamente en formato JSON. |
|
|
request123
|
request123 |
Crear carpeta de datos adjuntos
Crea una nueva carpeta de datos adjuntos para un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que contiene los datos adjuntos.
|
ItemID | True | integer |
El identificador del elemento que contiene los datos adjuntos se puede obtener a través de la llamada a get Item List API. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Crear datos adjuntos
Crea o carga un nuevo archivo adjunto para un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar los detalles.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles se puede obtener a través de la llamada a get Item List API. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Crear elemento de relación de elemento
Crea una nueva relación para un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para crear una nueva relación.
|
ItemID | True | integer |
El identificador del elemento para el que se crea una nueva relación (vincularla con otro elemento), se puede obtener a través de la llamada a get Item List API. |
|
Especifica la ubicación de un elemento específico dentro de un área de trabajo.
|
content-location | string |
Especifica la ubicación de un elemento específico dentro de un área de trabajo. El valor contiene marcadores de posición como :WorkspaceID y :ItemID, que deben reemplazarse por identificadores reales. |
|
|
request123
|
request123 |
Crear fila de elemento
Crea una nueva fila para un elemento específico dentro de la cuadrícula.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para crear una fila de cuadrícula.
|
ItemID | True | integer |
El identificador del elemento para el que desea crear una fila de cuadrícula, se puede obtener a través de la llamada a get Item List API. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Crear script nuevo
Crea un nuevo script del tipo especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | True | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
request123
|
request123 |
Descarga de informes
Recupera información detallada sobre un informe o descarga el informe
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar los detalles.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del informe que se va a descargar.
|
ReportID | True | integer |
Identificador del informe que desea descargar. |
|
Especifica el número de página de los resultados que se van a recuperar.
|
page | string |
Especifica el número de página de los resultados que se van a recuperar. Se usa para paginar a través de grandes conjuntos de datos. |
|
|
Especifica el campo para ordenar los resultados en orden ascendente.
|
asc | string |
Especifica el campo por el que se deben ordenar los resultados en orden ascendente. |
|
|
Especifica el campo para ordenar los resultados en orden descendente.
|
desc | string |
Especifica el campo por el que se deben ordenar los resultados en orden descendente. |
|
|
Especifica el número de elementos que se van a devolver por página en una respuesta paginada.
|
size | string |
Especifica el número de elementos que se van a devolver por página en una respuesta paginada. Esto permite a los clientes controlar el tamaño del conjunto de resultados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.columns.items.properties.displayName.type | string | |
|
type
|
properties.columns.items.properties.id.type | string | |
|
type
|
properties.columns.items.properties.index.type | string | |
|
required
|
properties.columns.items.required | array of string | |
|
type
|
properties.columns.items.type | string | |
|
type
|
properties.columns.type | string | |
|
type
|
properties.items.items.properties.fields.items.properties.id.type | string | |
|
type
|
properties.items.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.items.items.properties.fields.items.required | array of string | |
|
type
|
properties.items.items.properties.fields.items.type | string | |
|
type
|
properties.items.items.properties.fields.type | string | |
|
type
|
properties.items.items.properties.index.type | string | |
|
type
|
properties.items.items.properties.item.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.item.properties.link.type | string | |
|
type
|
properties.items.items.properties.item.properties.urn.type | string | |
|
type
|
properties.items.items.properties.item.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.pageNumber.type | string | |
|
type
|
properties.pageSize.type | string | |
|
type
|
properties.sortingColumns.items.properties.id.type | string | |
|
type
|
properties.sortingColumns.items.properties.index.type | string | |
|
type
|
properties.sortingColumns.items.properties.order.type | string | |
|
required
|
properties.sortingColumns.items.required | array of string | |
|
type
|
properties.sortingColumns.items.type | string | |
|
type
|
properties.sortingColumns.type | string | |
|
type
|
properties.total.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Detalle del elemento de relación de elemento V1
Recupera una lista de relaciones para un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Indica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Indica el identificador del elemento para recuperar los detalles de la relación.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles de la relación de se puede obtener a través de la llamada a GET Item List API. |
|
Especifica el número de página para la recuperación de resultados.
|
page | string |
Especifica el número de página de los resultados que se van a recuperar. Se usa para paginar a través de grandes conjuntos de datos. |
|
|
Especifica el número de elementos por página en una respuesta paginada.
|
size | string |
Especifica el número de elementos que se van a devolver por página en una respuesta paginada. Esto permite a los clientes controlar el tamaño del conjunto de resultados. |
|
|
Especifica el campo usado para ordenar los resultados.
|
sort | string |
Especifica el campo por el que se ordenan los resultados. Ejemplo: "createdOn" para ordenar por fecha de creación. |
|
|
Especifica la dirección de ordenación de los resultados.
|
sortDirection | string |
Especifica la dirección de ordenación. Use "ASC" para ascendente y "DESC" para descendente. Ejemplo: "ASC" para ordenar en orden ascendente. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.list.properties.item-relationship.items.properties.description.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.direction.properties.label.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.direction.properties.value.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.direction.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.description.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.deleted.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.dmsID.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.latest.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.effectivity.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateID.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateName.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.timeStamp.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.version.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.versionID.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateId.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateName.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.working.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workspaceID.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.details.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.id.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.dataType.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.value.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.key.type | string | |
|
required
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.required | array of string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.properties.uri.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.item.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.type.properties.label.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.type.properties.value.type | string | |
|
type
|
properties.list.properties.item-relationship.items.properties.type.type | string | |
|
required
|
properties.list.properties.item-relationship.items.required | array of string | |
|
type
|
properties.list.properties.item-relationship.items.type | string | |
|
type
|
properties.list.properties.item-relationship.type | string | |
|
type
|
properties.list.type | string | |
|
type
|
type | string |
Detalles de actualización de elementos
Actualiza los detalles de un elemento específico, quitando los detalles que no se especifican.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para actualizar los detalles.
|
ItemID | True | integer |
El identificador del elemento para el que desea actualizar los detalles del elemento, se puede obtener a través de la llamada a la API GET Item List. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Detalles de actualización de elementos: parcial
Actualiza parcialmente los detalles de un elemento específico, conservando los detalles no especificados.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para actualizar los detalles.
|
ItemID | True | integer |
El identificador del elemento para el que desea actualizar los detalles del elemento, se puede obtener a través de la llamada a la API GET Item List. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Detalles de grupos
Recupera información detallada sobre un grupo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del grupo para recuperar los detalles.
|
GroupID | True | integer |
El identificador del grupo para el que desea recuperar los detalles se puede obtener a través de la llamada a la API GET Groups List. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.exclusiveGroup.type | string | |
|
type
|
properties.isSystemManaged.type | string | |
|
type
|
properties.mappedToOxygen.type | string | |
|
type
|
properties.minUserCount.type | string | |
|
type
|
properties.restrictIp.type | string | |
|
type
|
properties.shortName.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Detalles de la lista de selección
Recupera los detalles de las búsquedas de listas de selección.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador personalizado de picklist/Lookup para la recuperación de detalles.
|
PicklistID | True | string |
Identificador personalizado de la lista de selección o búsqueda para la que desea recuperar los detalles. |
|
Especifica el índice inicial para recuperar elementos en un conjunto de resultados paginado.
|
offset | string |
Especifica el punto de partida o el índice desde el que se van a recuperar elementos de un conjunto de resultados paginado. Resulta útil para omitir un número determinado de elementos de la lista. |
|
|
Especifica el número máximo de elementos que se van a devolver en la respuesta.
|
limit | string |
Especifica el número máximo de elementos que se van a devolver en la respuesta. Se usa para limitar el tamaño del conjunto de resultados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.properties.urn.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.link.type | string | |
|
type
|
properties.items.items.properties.title.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.properties.urn.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Detalles de la vista de usuario
Recupera información detallada sobre la vista de un usuario específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles se puede obtener a través de la llamada a get Item List API. |
|
Especifica el identificador de la vista de usuario para recuperar los detalles.
|
ViewID | True | integer |
El identificador de la vista de usuario para la que desea recuperar los detalles se puede obtener a través de la llamada API de nivel de acceso basado en GET User Views. |
|
Especifica el campo para ordenar los resultados en orden ascendente.
|
asc | string |
Especifica el campo por el que se deben ordenar los resultados en orden ascendente. |
|
|
Especifica el campo para ordenar los resultados en orden descendente.
|
desc | string |
Especifica el campo por el que se deben ordenar los resultados en orden descendente. |
|
|
Especifica el número de página de los resultados que se van a recuperar.
|
page | string |
Especifica el número de página de los resultados que se van a recuperar. Se usa para paginar a través de grandes conjuntos de datos. |
|
|
Especifica el número de elementos que se van a devolver por página en una respuesta paginada.
|
size | string |
Especifica el número de elementos que se van a devolver por página en una respuesta paginada. Esto permite a los clientes controlar el tamaño del conjunto de resultados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.columns.items.properties.displayName.type | string | |
|
type
|
properties.columns.items.properties.id.type | string | |
|
type
|
properties.columns.items.properties.index.type | string | |
|
required
|
properties.columns.items.required | array of string | |
|
type
|
properties.columns.items.type | string | |
|
type
|
properties.columns.type | string | |
|
items
|
properties.items | array of string | |
|
type
|
properties.pageNumber.type | string | |
|
type
|
properties.pageSize.type | string | |
|
type
|
properties.sortingColumns.items.properties.id.type | string | |
|
type
|
properties.sortingColumns.items.properties.index.type | string | |
|
type
|
properties.sortingColumns.items.properties.order.type | string | |
|
required
|
properties.sortingColumns.items.required | array of string | |
|
type
|
properties.sortingColumns.items.type | string | |
|
type
|
properties.sortingColumns.type | string | |
|
type
|
properties.total.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Detalles de los datos adjuntos
Recupera información detallada sobre un archivo adjunto específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del elemento que se va a recuperar.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles se puede obtener a través de la llamada a get Item List API. |
|
Especifica el identificador de los datos adjuntos para recuperar los detalles.
|
AttachmentID | True | integer |
El identificador de los datos adjuntos para los que desea recuperar los detalles se puede obtener a través de la llamada a la API GET Attachments List. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.fileUrl.type | string | |
|
type
|
type | string |
Detalles del campo de elemento
Muestra información detallada sobre el campo especificado dentro de una cuadrícula de elementos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del campo de cuadrícula para la recuperación detallada.
|
FieldID | True | integer |
Identificador del campo de cuadrícula para el que desea recuperar los detalles. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.defaultValue.type | string | |
|
type
|
properties.description.type | string | |
|
type
|
properties.label.type | string | |
|
type
|
properties.type.properties.deleted.type | string | |
|
type
|
properties.type.properties.link.type | string | |
|
type
|
properties.type.properties.title.type | string | |
|
type
|
properties.type.properties.urn.type | string | |
|
type
|
properties.type.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Detalles del elemento
Recupera información detallada sobre un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles se puede obtener a través de la llamada a get Item List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.audit.properties.deleted.type | string | |
|
type
|
properties.audit.properties.link.type | string | |
|
type
|
properties.audit.type | string | |
|
type
|
properties.bom.properties.deleted.type | string | |
|
type
|
properties.bom.properties.link.type | string | |
|
type
|
properties.bom.type | string | |
|
type
|
properties.currentState.properties.deleted.type | string | |
|
type
|
properties.currentState.properties.link.type | string | |
|
type
|
properties.currentState.properties.title.type | string | |
|
type
|
properties.currentState.properties.urn.type | string | |
|
type
|
properties.currentState.type | string | |
|
type
|
properties.deleted.type | string | |
|
type
|
properties.flatBom.properties.deleted.type | string | |
|
type
|
properties.flatBom.properties.link.type | string | |
|
type
|
properties.flatBom.type | string | |
|
type
|
properties.itemLocked.type | string | |
|
type
|
properties.latestRelease.type | string | |
|
type
|
properties.lifecycle.properties.deleted.type | string | |
|
type
|
properties.lifecycle.properties.link.type | string | |
|
type
|
properties.lifecycle.properties.title.type | string | |
|
type
|
properties.lifecycle.properties.urn.type | string | |
|
type
|
properties.lifecycle.type | string | |
|
type
|
properties.milestones.properties.deleted.type | string | |
|
type
|
properties.milestones.properties.link.type | string | |
|
type
|
properties.milestones.type | string | |
|
type
|
properties.nestedBom.properties.count.type | string | |
|
type
|
properties.nestedBom.properties.deleted.type | string | |
|
type
|
properties.nestedBom.properties.link.type | string | |
|
type
|
properties.nestedBom.type | string | |
|
type
|
properties.owners.properties.deleted.type | string | |
|
type
|
properties.owners.properties.link.type | string | |
|
type
|
properties.owners.type | string | |
|
type
|
properties.revertible.type | string | |
|
type
|
properties.root.properties.deleted.type | string | |
|
type
|
properties.root.properties.link.type | string | |
|
type
|
properties.root.properties.title.type | string | |
|
type
|
properties.root.properties.urn.type | string | |
|
type
|
properties.root.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.__self__.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.defaultValue.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.formulaField.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.isSystemField.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.title.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.type.properties.link.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.type.properties.title.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.type.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.urn.type | string | |
|
type
|
properties.sections.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.sections.items.properties.fields.items.required | array of string | |
|
type
|
properties.sections.items.properties.fields.items.type | string | |
|
type
|
properties.sections.items.properties.fields.type | string | |
|
type
|
properties.sections.items.properties.link.type | string | |
|
type
|
properties.sections.items.properties.sectionLocked.type | string | |
|
type
|
properties.sections.items.properties.title.type | string | |
|
required
|
properties.sections.items.required | array of string | |
|
type
|
properties.sections.items.type | string | |
|
type
|
properties.sections.type | string | |
|
type
|
properties.sectionsLink.type | string | |
|
type
|
properties.title.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
properties.whereUsed.properties.count.properties.type.type | string | |
|
type
|
properties.whereUsed.properties.count.properties.value.type | string | |
|
type
|
properties.whereUsed.properties.count.type | string | |
|
type
|
properties.whereUsed.properties.link.type | string | |
|
type
|
properties.whereUsed.type | string | |
|
type
|
properties.workflowReference.type | string | |
|
type
|
properties.workingHasChanged.type | string | |
|
type
|
properties.workingVersion.type | string | |
|
type
|
properties.workspace.properties.deleted.type | string | |
|
type
|
properties.workspace.properties.link.type | string | |
|
type
|
properties.workspace.properties.title.type | string | |
|
type
|
properties.workspace.properties.type.type | string | |
|
type
|
properties.workspace.properties.urn.type | string | |
|
type
|
properties.workspace.type | string | |
|
type
|
type | string |
Detalles del informe
Recupera los detalles de configuración completos del informe.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del informe para recuperar los detalles.
|
ReportID | True | integer |
Identificador del informe del que desea recuperar los detalles. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.reportDefinition.properties.hasOrphanFields.type | string | |
|
type
|
properties.reportDefinition.properties.id.type | string | |
|
type
|
properties.reportDefinition.properties.isChartReport.type | string | |
|
type
|
properties.reportDefinition.properties.modifiedDate.type | string | |
|
type
|
properties.reportDefinition.properties.name.type | string | |
|
type
|
properties.reportDefinition.properties.owner.type | string | |
|
type
|
properties.reportDefinition.properties.workspaceId.type | string | |
|
type
|
properties.reportDefinition.type | string | |
|
type
|
properties.reportResult.properties.columnKey.items.properties.label.type | string | |
|
type
|
properties.reportResult.properties.columnKey.items.properties.value.type | string | |
|
required
|
properties.reportResult.properties.columnKey.items.required | array of string | |
|
type
|
properties.reportResult.properties.columnKey.items.type | string | |
|
type
|
properties.reportResult.properties.columnKey.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.dataType.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.label.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.value.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.key.type | string | |
|
required
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.required | array of string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.fields.type | string | |
|
type
|
properties.reportResult.properties.row.items.properties.rowId.type | string | |
|
required
|
properties.reportResult.properties.row.items.required | array of string | |
|
type
|
properties.reportResult.properties.row.items.type | string | |
|
type
|
properties.reportResult.properties.row.type | string | |
|
type
|
properties.reportResult.properties.totalResultCount.type | string | |
|
type
|
properties.reportResult.type | string | |
|
type
|
type | string |
Detalles del permiso
Recupera información detallada sobre un permiso específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del permiso para recuperar los detalles.
|
PermissionID | True | integer |
El identificador del permiso para el que desea recuperar los detalles se puede obtener a través de la llamada a get Permission List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.id.type | string | |
|
type
|
properties.longName.type | string | |
|
type
|
properties.shortName.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Detalles del permiso de usuario
Recupera los detalles del permiso para un usuario específico dentro de un área de trabajo específica, en función del identificador de permiso proporcionado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar los detalles.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del usuario para recuperar los detalles.
|
UserID | True | string |
El identificador del usuario para el que desea recuperar los detalles se puede obtener a través de la llamada a GET Users List API. |
|
Especifica el identificador del permiso para recuperar los detalles.
|
PermissionID | True | integer |
El identificador del permiso para el que desea recuperar los detalles se puede obtener a través de la llamada a get Permission List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.id.type | string | |
|
type
|
properties.longName.type | string | |
|
type
|
properties.shortName.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Detalles del script
Recupera el contenido y los detalles de un script específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador único del script.
|
ScriptID | True | integer |
Identificador único del script que se va a recuperar o manipular. Se trata de un parámetro necesario y debe proporcionar un scriptID válido como un entero en la ruta de acceso de la solicitud. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.code.type | string | |
|
dependsOn
|
properties.dependsOn | array of string | |
|
type
|
properties.displayName.type | string | |
|
type
|
properties.scriptType.type | string | |
|
type
|
properties.uniqueName.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
properties.version.type | string | |
|
type
|
type | string |
Detalles del usuario
Recupera información detallada sobre el usuario especificado. Si @me se usa, la API devolverá detalles sobre el usuario que realiza la llamada API.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del usuario para recuperar los detalles.
|
UserID | True | string |
El identificador del usuario para el que desea recuperar los detalles se puede obtener a través de la llamada a GET Users List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
aboutMe
|
properties.aboutMe | object | |
|
type
|
properties.active.type | string | |
|
type
|
properties.address1.type | string | |
|
type
|
properties.address2.type | string | |
|
type
|
properties.alerts.items.properties.acknowledged.type | string | |
|
type
|
properties.alerts.items.properties.deleted.type | string | |
|
type
|
properties.alerts.items.properties.link.type | string | |
|
type
|
properties.alerts.items.properties.message.type | string | |
|
type
|
properties.alerts.items.properties.priority.type | string | |
|
type
|
properties.alerts.items.properties.title.type | string | |
|
type
|
properties.alerts.items.properties.type.type | string | |
|
type
|
properties.alerts.items.properties.urgent.type | string | |
|
type
|
properties.alerts.items.properties.urn.type | string | |
|
required
|
properties.alerts.items.required | array of string | |
|
type
|
properties.alerts.items.type | string | |
|
type
|
properties.alerts.type | string | |
|
type
|
properties.analyticsId.type | string | |
|
type
|
properties.batchNotifyPref.type | string | |
|
celular
|
properties.cellular | object | |
|
type
|
properties.city.type | string | |
|
type
|
properties.consumeLicense.type | string | |
|
type
|
properties.country.type | string | |
|
dashboardCharts
|
properties.dashboardCharts | object | |
|
type
|
properties.dateFormat.type | string | |
|
items
|
properties.delegations.items | string | |
|
type
|
properties.displayName.type | string | |
|
type
|
properties.displayNameExtended.type | string | |
|
type
|
properties.email.type | string | |
|
type
|
properties.enforce2fa.type | string | |
|
type
|
properties.entitlement.type | string | |
|
externalAuthReservationToken
|
properties.externalAuthReservationToken | object | |
|
type
|
properties.externalAuthUserId.type | string | |
|
fax
|
properties.fax | object | |
|
type
|
properties.firstName.type | string | |
|
type
|
properties.groups.items.properties.link.type | string | |
|
type
|
properties.groups.items.properties.longName.type | string | |
|
type
|
properties.groups.items.properties.shortName.type | string | |
|
type
|
properties.groups.items.properties.urn.type | string | |
|
required
|
properties.groups.items.required | array of string | |
|
type
|
properties.groups.items.type | string | |
|
type
|
properties.groups.type | string | |
|
type
|
properties.id.type | string | |
|
type
|
properties.image.properties.large.type | string | |
|
type
|
properties.image.properties.medium.type | string | |
|
type
|
properties.image.properties.small.type | string | |
|
type
|
properties.image.type | string | |
|
industria
|
properties.industry | object | |
|
type
|
properties.interfaceStyle.type | string | |
|
type
|
properties.interfaceStyleMandated.type | string | |
|
type
|
properties.lastAccessTime.type | string | |
|
type
|
properties.lastLicenseTimeIssued.type | string | |
|
type
|
properties.lastLoginTime.type | string | |
|
type
|
properties.lastMowUpdateDate.type | string | |
|
type
|
properties.lastName.type | string | |
|
type
|
properties.lastRecalculateStarted.type | string | |
|
type
|
properties.lastRecalculateUpdate.type | string | |
|
type
|
properties.ldapEnabled.type | string | |
|
licenseFeatureId
|
properties.licenseFeatureId | object | |
|
type
|
properties.licenseType.properties.deleted.type | string | |
|
type
|
properties.licenseType.properties.description.type | string | |
|
type
|
properties.licenseType.properties.link.type | string | |
|
type
|
properties.licenseType.properties.title.type | string | |
|
type
|
properties.licenseType.properties.type.type | string | |
|
type
|
properties.licenseType.properties.urn.type | string | |
|
type
|
properties.licenseType.type | string | |
|
type
|
properties.loginName.type | string | |
|
type
|
properties.mappedToOxygen.type | string | |
|
type
|
properties.organization.type | string | |
|
phone
|
properties.phone | object | |
|
type
|
properties.plmSearchCrawlerUser.type | string | |
|
type
|
properties.postal.type | string | |
|
type
|
properties.preferences.type | string | |
|
type
|
properties.regularUser.type | string | |
|
type
|
properties.reset.type | string | |
|
type
|
properties.showEnableFullAccess.type | string | |
|
signupUrl
|
properties.signupUrl | object | |
|
type
|
properties.stateProv.type | string | |
|
type
|
properties.surveyDone.type | string | |
|
type
|
properties.tenantAdmin.type | string | |
|
type
|
properties.thumbnailPref.type | string | |
|
type
|
properties.timezone.type | string | |
|
type
|
properties.title.type | string | |
|
type
|
properties.twoFaEnabled.type | string | |
|
type
|
properties.twoFactorAuthEnabled.type | string | |
|
type
|
properties.uomPref.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
properties.userActive.type | string | |
|
type
|
properties.userId.type | string | |
|
type
|
properties.userInactive.type | string | |
|
type
|
properties.userNumber.type | string | |
|
type
|
properties.userStatus.type | string | |
|
type
|
properties.wfNotifyPref.type | string | |
|
type
|
type | string |
Elemento donde se usa
Recupera una lista de dónde se usa el elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento usado en la lista de materiales.
|
ItemID | True | integer |
El identificador del elemento usado en la lista de materiales se puede obtener a través de la llamada a la API GET Item List. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.config.properties.bias.type | string | |
|
type
|
properties.config.properties.bomViewDate.type | string | |
|
type
|
properties.config.properties.viewDef.properties.deleted.type | string | |
|
type
|
properties.config.properties.viewDef.properties.link.type | string | |
|
type
|
properties.config.properties.viewDef.properties.urn.type | string | |
|
type
|
properties.config.properties.viewDef.type | string | |
|
type
|
properties.config.type | string | |
|
type
|
properties.edges.items.properties.child.type | string | |
|
type
|
properties.edges.items.properties.depth.type | string | |
|
type
|
properties.edges.items.properties.edgeId.type | string | |
|
type
|
properties.edges.items.properties.edgeLink.type | string | |
|
fields
|
properties.edges.items.properties.fields | array of string | |
|
type
|
properties.edges.items.properties.itemNumber.type | string | |
|
type
|
properties.edges.items.properties.lastNode.type | string | |
|
type
|
properties.edges.items.properties.parent.type | string | |
|
required
|
properties.edges.items.required | array of string | |
|
type
|
properties.edges.items.type | string | |
|
type
|
properties.edges.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.nodes.items.properties.bomItems.type | string | |
|
type
|
properties.nodes.items.properties.bomRoot.type | string | |
|
type
|
properties.nodes.items.properties.fields.items.properties.isSystemField.type | string | |
|
type
|
properties.nodes.items.properties.fields.items.properties.title.type | string | |
|
type
|
properties.nodes.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.nodes.items.properties.fields.items.required | array of string | |
|
type
|
properties.nodes.items.properties.fields.items.type | string | |
|
type
|
properties.nodes.items.properties.fields.type | string | |
|
type
|
properties.nodes.items.properties.item.properties.deleted.type | string | |
|
type
|
properties.nodes.items.properties.item.properties.link.type | string | |
|
type
|
properties.nodes.items.properties.item.properties.title.type | string | |
|
type
|
properties.nodes.items.properties.item.properties.urn.type | string | |
|
type
|
properties.nodes.items.properties.item.properties.version.type | string | |
|
type
|
properties.nodes.items.properties.item.type | string | |
|
required
|
properties.nodes.items.required | array of string | |
|
type
|
properties.nodes.items.type | string | |
|
type
|
properties.nodes.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.root.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Elementos administrados de elementos
Recupera una lista de elementos administrados asociados a un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar los detalles.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles se puede obtener a través de la llamada a get Item List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.affectedItems.items.properties.__self__.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.deleted.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.link.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.title.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.urn.type | string | |
|
type
|
properties.affectedItems.items.properties.item.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.title.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.uom.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.urn.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.value.type | string | |
|
required
|
properties.affectedItems.items.properties.linkedFields.items.required | array of string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.type | string | |
|
type
|
properties.affectedItems.items.properties.type.type | string | |
|
type
|
properties.affectedItems.items.properties.urn.type | string | |
|
required
|
properties.affectedItems.items.required | array of string | |
|
type
|
properties.affectedItems.items.type | string | |
|
type
|
properties.affectedItems.type | string | |
|
type
|
type | string |
Elementos del área de trabajo
Recupera una lista de todos los elementos de un área de trabajo específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el número máximo de elementos que se van a devolver en la respuesta.
|
limit | string |
Especifica el número máximo de elementos que se van a devolver en la respuesta. Se usa para limitar el tamaño del conjunto de resultados. |
|
|
Especifica el tipo de medio esperado en la respuesta.
|
Accept | string |
Especifica el tipo de medio que el cliente espera en la respuesta. En este caso, el cliente solicita que la respuesta esté en formato de datos de elementos masivos en formato JSON. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.__self__.type | string | |
|
type
|
properties.items.items.properties.audit.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.audit.properties.link.type | string | |
|
type
|
properties.items.items.properties.audit.type | string | |
|
type
|
properties.items.items.properties.bom.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.bom.properties.link.type | string | |
|
type
|
properties.items.items.properties.bom.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.link.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.title.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.urn.type | string | |
|
type
|
properties.items.items.properties.currentState.type | string | |
|
type
|
properties.items.items.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.flatBom.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.flatBom.properties.link.type | string | |
|
type
|
properties.items.items.properties.flatBom.type | string | |
|
type
|
properties.items.items.properties.itemLocked.type | string | |
|
type
|
properties.items.items.properties.latestRelease.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.link.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.title.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.urn.type | string | |
|
type
|
properties.items.items.properties.lifecycle.type | string | |
|
type
|
properties.items.items.properties.milestones.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.milestones.properties.link.type | string | |
|
type
|
properties.items.items.properties.milestones.type | string | |
|
type
|
properties.items.items.properties.nestedBom.properties.count.type | string | |
|
type
|
properties.items.items.properties.nestedBom.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.nestedBom.properties.link.type | string | |
|
type
|
properties.items.items.properties.nestedBom.type | string | |
|
type
|
properties.items.items.properties.owners.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.owners.properties.link.type | string | |
|
type
|
properties.items.items.properties.owners.type | string | |
|
type
|
properties.items.items.properties.root.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.root.properties.link.type | string | |
|
type
|
properties.items.items.properties.root.properties.title.type | string | |
|
type
|
properties.items.items.properties.root.properties.urn.type | string | |
|
type
|
properties.items.items.properties.root.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.title.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.items.items.properties.sections.items.properties.fields.items.required | array of string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.link.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.sectionLocked.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.title.type | string | |
|
required
|
properties.items.items.properties.sections.items.required | array of string | |
|
type
|
properties.items.items.properties.sections.items.type | string | |
|
type
|
properties.items.items.properties.sections.type | string | |
|
type
|
properties.items.items.properties.sectionsLink.type | string | |
|
type
|
properties.items.items.properties.title.type | string | |
|
type
|
properties.items.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.count.properties.type.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.count.properties.value.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.count.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.link.type | string | |
|
type
|
properties.items.items.properties.whereUsed.type | string | |
|
type
|
properties.items.items.properties.workflowReference.type | string | |
|
type
|
properties.items.items.properties.workingHasChanged.type | string | |
|
type
|
properties.items.items.properties.workingVersion.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.link.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.title.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.type.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.urn.type | string | |
|
type
|
properties.items.items.properties.workspace.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.next.properties.count.type | string | |
|
type
|
properties.next.properties.deleted.type | string | |
|
type
|
properties.next.properties.link.type | string | |
|
type
|
properties.next.properties.title.type | string | |
|
type
|
properties.next.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Filas de cuadrícula de elementos
Recupera una lista de filas y campos de un elemento específico, incluidos sus valores.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles se puede obtener a través de la llamada a get Item List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.aggregations.items.properties.__self__.type | string | |
|
type
|
properties.aggregations.items.properties.isSystemField.type | string | |
|
type
|
properties.aggregations.items.properties.title.type | string | |
|
type
|
properties.aggregations.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.aggregations.items.properties.type.properties.link.type | string | |
|
type
|
properties.aggregations.items.properties.type.properties.title.type | string | |
|
type
|
properties.aggregations.items.properties.type.properties.urn.type | string | |
|
type
|
properties.aggregations.items.properties.type.type | string | |
|
type
|
properties.aggregations.items.properties.urn.type | string | |
|
type
|
properties.aggregations.items.properties.value.type | string | |
|
required
|
properties.aggregations.items.required | array of string | |
|
type
|
properties.aggregations.items.type | string | |
|
type
|
properties.aggregations.type | string | |
|
Propiedades
|
properties.rows.items.properties.metaFieldTableBean.properties.dataMap.properties | object | |
|
type
|
properties.rows.items.properties.metaFieldTableBean.properties.dataMap.type | string | |
|
type
|
properties.rows.items.properties.metaFieldTableBean.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.__self__.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.formulaField.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.isSystemField.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.title.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.type.properties.link.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.type.properties.urn.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.type.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.urn.type | string | |
|
type
|
properties.rows.items.properties.rowData.items.properties.value.type | string | |
|
required
|
properties.rows.items.properties.rowData.items.required | array of string | |
|
type
|
properties.rows.items.properties.rowData.items.type | string | |
|
type
|
properties.rows.items.properties.rowData.type | string | |
|
type
|
properties.rows.items.properties.rowID.type | string | |
|
required
|
properties.rows.items.required | array of string | |
|
type
|
properties.rows.items.type | string | |
|
type
|
properties.rows.type | string | |
|
type
|
type | string |
Información general sobre la pestaña Elementos
Recupera una lista de registros y campos de una pestaña específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para recuperar registros y campos de una pestaña o vista.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar una lista de registros y campos para una pestaña o vista específica, se puede obtener a través de la llamada a la API GET Item List. |
|
Especifica el identificador de la pestaña o vista para la recuperación de detalles.
|
ViewID | True | integer |
Identificador de la pestaña o vista para la que desea recuperar los detalles. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.__self__.type | string | |
|
longName
|
properties.items.items.properties.action.properties.longName | object | |
|
notifyPermission
|
properties.items.items.properties.action.properties.notifyPermission | object | |
|
type
|
properties.items.items.properties.action.properties.shortName.type | string | |
|
type
|
properties.items.items.properties.action.type | string | |
|
type
|
properties.items.items.properties.actionInvoker.type | string | |
|
type
|
properties.items.items.properties.description.type | string | |
|
type
|
properties.items.items.properties.details.type | string | |
|
type
|
properties.items.items.properties.timeStamp.type | string | |
|
type
|
properties.items.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.user.properties.email.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.large.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.medium.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.small.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.type | string | |
|
type
|
properties.items.items.properties.user.properties.link.type | string | |
|
type
|
properties.items.items.properties.user.properties.status.type | string | |
|
type
|
properties.items.items.properties.user.properties.title.type | string | |
|
type
|
properties.items.items.properties.user.properties.urn.type | string | |
|
type
|
properties.items.items.properties.user.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Item PrintView
Genera una vista de impresión de un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene los elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene los elementos, se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para crear una vista de impresión.
|
ItemID | True | integer |
El identificador del elemento para el que se crea una vista de impresión, se puede obtener a través de la llamada a la API GET Item List. |
|
Especifica el identificador de printview.
|
PrintViewID | True | string |
El identificador de Printview, por ejemplo: "APV-123" |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.hide.type | string | |
|
type
|
properties.printName.type | string | |
|
type
|
properties.urn.type | string | |
|
type
|
type | string |
Lista de campos de detalles del elemento
Recupera una lista de todos los campos disponibles en la pestaña Detalles del elemento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para la recuperación de detalles del campo.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles del campo se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el tipo de medio esperado en la respuesta.
|
Accept | string |
Especifica el tipo de medio que el cliente espera en la respuesta. En este caso, el cliente solicita que la respuesta esté en formato JSON. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.fields.items.properties.__self__.type | string | |
|
type
|
properties.fields.items.properties.defaultValue.type | string | |
|
type
|
properties.fields.items.properties.derived.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.__self__.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.title.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.deleted.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.link.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.title.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.urn.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.type.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.properties.urn.type | string | |
|
type
|
properties.fields.items.properties.derivedFieldSource.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.__self__.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.title.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.link.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.title.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.type.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.items.properties.urn.type | string | |
|
required
|
properties.fields.items.properties.derivedFields.items.required | array of string | |
|
type
|
properties.fields.items.properties.derivedFields.items.type | string | |
|
type
|
properties.fields.items.properties.derivedFields.type | string | |
|
type
|
properties.fields.items.properties.description.type | string | |
|
displayLength
|
properties.fields.items.properties.displayLength | object | |
|
type
|
properties.fields.items.properties.displayOrder.type | string | |
|
type
|
properties.fields.items.properties.editability.type | string | |
|
fieldLength
|
properties.fields.items.properties.fieldLength | object | |
|
fieldPrecision
|
properties.fields.items.properties.fieldPrecision | object | |
|
fieldValidators
|
properties.fields.items.properties.fieldValidators | array of string | |
|
type
|
properties.fields.items.properties.formulaField.type | string | |
|
label
|
properties.fields.items.properties.label | object | |
|
type
|
properties.fields.items.properties.name.type | string | |
|
picklist
|
properties.fields.items.properties.picklist | object | |
|
picklistFieldDefinition
|
properties.fields.items.properties.picklistFieldDefinition | object | |
|
type
|
properties.fields.items.properties.pivotLink.type | string | |
|
type
|
properties.fields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.fields.items.properties.type.properties.link.type | string | |
|
type
|
properties.fields.items.properties.type.properties.title.type | string | |
|
type
|
properties.fields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.fields.items.properties.type.type | string | |
|
unidad de medida
|
properties.fields.items.properties.unitOfMeasure | object | |
|
type
|
properties.fields.items.properties.urn.type | string | |
|
validadores
|
properties.fields.items.properties.validators | object | |
|
type
|
properties.fields.items.properties.visibility.type | string | |
|
type
|
properties.fields.items.properties.visibleOnPreview.type | string | |
|
required
|
properties.fields.items.required | array of string | |
|
type
|
properties.fields.items.type | string | |
|
type
|
properties.fields.type | string | |
|
type
|
type | string |
Lista de datos adjuntos
Recupera una lista de todos los datos adjuntos de un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar los detalles.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar los detalles se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar los detalles se puede obtener a través de la llamada a get Item List API. |
|
Especifica el campo para ordenar los resultados en orden ascendente.
|
asc | string |
Especifica el campo por el que se deben ordenar los resultados en orden ascendente. Por ejemplo, use 'name' para ordenar los resultados por el campo de nombre en orden ascendente. |
|
|
Especifica el tipo de medio esperado en la respuesta.
|
Accept | string |
Especifica el tipo de medio que el cliente espera en la respuesta. En este caso, el cliente solicita que la respuesta esté en formato de datos adjuntos masivos en formato JSON. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.attachments.items.properties.created.properties.timeStamp.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.email.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.image.properties.large.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.image.properties.medium.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.image.properties.small.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.image.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.link.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.status.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.title.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.properties.urn.type | string | |
|
type
|
properties.attachments.items.properties.created.properties.user.type | string | |
|
type
|
properties.attachments.items.properties.created.type | string | |
|
type
|
properties.attachments.items.properties.description.type | string | |
|
type
|
properties.attachments.items.properties.folder.properties.id.type | string | |
|
type
|
properties.attachments.items.properties.folder.properties.name.type | string | |
|
type
|
properties.attachments.items.properties.folder.type | string | |
|
type
|
properties.attachments.items.properties.id.type | string | |
|
type
|
properties.attachments.items.properties.markups.properties.count.type | string | |
|
type
|
properties.attachments.items.properties.markups.properties.deleted.type | string | |
|
type
|
properties.attachments.items.properties.markups.properties.link.type | string | |
|
type
|
properties.attachments.items.properties.markups.type | string | |
|
type
|
properties.attachments.items.properties.name.type | string | |
|
type
|
properties.attachments.items.properties.resourceName.type | string | |
|
type
|
properties.attachments.items.properties.selfLink.type | string | |
|
type
|
properties.attachments.items.properties.size.type | string | |
|
type
|
properties.attachments.items.properties.status.properties.description.type | string | |
|
type
|
properties.attachments.items.properties.status.properties.label.type | string | |
|
type
|
properties.attachments.items.properties.status.properties.name.type | string | |
|
type
|
properties.attachments.items.properties.status.type | string | |
|
type
|
properties.attachments.items.properties.thumbnails.properties.large.type | string | |
|
type
|
properties.attachments.items.properties.thumbnails.properties.medium.type | string | |
|
type
|
properties.attachments.items.properties.thumbnails.properties.small.type | string | |
|
type
|
properties.attachments.items.properties.thumbnails.type | string | |
|
type
|
properties.attachments.items.properties.type.properties.extension.type | string | |
|
type
|
properties.attachments.items.properties.type.properties.fileType.type | string | |
|
type
|
properties.attachments.items.properties.type.properties.iconImage.type | string | |
|
type
|
properties.attachments.items.properties.type.properties.id.type | string | |
|
type
|
properties.attachments.items.properties.type.properties.viewable.type | string | |
|
type
|
properties.attachments.items.properties.type.type | string | |
|
type
|
properties.attachments.items.properties.url.type | string | |
|
type
|
properties.attachments.items.properties.urn.type | string | |
|
type
|
properties.attachments.items.properties.version.type | string | |
|
required
|
properties.attachments.items.required | array of string | |
|
type
|
properties.attachments.items.type | string | |
|
type
|
properties.attachments.type | string | |
|
type
|
properties.item.properties.deleted.type | string | |
|
type
|
properties.item.properties.link.type | string | |
|
type
|
properties.item.properties.title.type | string | |
|
type
|
properties.item.properties.urn.type | string | |
|
type
|
properties.item.type | string | |
|
type
|
type | string |
Lista de elementos administrados de elementos
Recupera una lista de elementos administrados asociados a un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que contiene la pestaña del elemento administrado.
|
ItemID | True | integer |
El identificador del elemento que contiene la pestaña del elemento administrado se puede obtener a través de la llamada a la API GET Item List. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.affectedItems.items.properties.__self__.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.deleted.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.link.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.title.type | string | |
|
type
|
properties.affectedItems.items.properties.item.properties.urn.type | string | |
|
type
|
properties.affectedItems.items.properties.item.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.title.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.uom.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.urn.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.properties.value.type | string | |
|
required
|
properties.affectedItems.items.properties.linkedFields.items.required | array of string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.items.type | string | |
|
type
|
properties.affectedItems.items.properties.linkedFields.type | string | |
|
type
|
properties.affectedItems.items.properties.type.type | string | |
|
type
|
properties.affectedItems.items.properties.urn.type | string | |
|
required
|
properties.affectedItems.items.required | array of string | |
|
type
|
properties.affectedItems.items.type | string | |
|
type
|
properties.affectedItems.type | string | |
|
type
|
type | string |
Lista de grupos
Recupera una lista de todos los grupos disponibles en el inquilino.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el índice para empezar a recuperar elementos de un conjunto de resultados paginado.
|
offset | string |
Especifica el punto de partida o el índice desde el que se van a recuperar elementos de un conjunto de resultados paginado. Resulta útil para omitir un número determinado de elementos de la lista. |
|
|
Especifica el número máximo de elementos que se van a devolver en la respuesta.
|
limit | string |
Especifica el número máximo de elementos que se van a devolver en la respuesta. Se usa para limitar el tamaño del conjunto de resultados. |
|
|
Ordena los resultados alfabéticamente en orden ascendente o descendente.
|
sort | string |
Ordena los resultados alfabéticamente ascendentes o descendentes en función del valor especificado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.groups.items.properties.__self__.type | string | |
|
type
|
properties.groups.items.properties.exclusiveGroup.type | string | |
|
type
|
properties.groups.items.properties.invariantName.type | string | |
|
type
|
properties.groups.items.properties.isSystemManaged.type | string | |
|
type
|
properties.groups.items.properties.longName.type | string | |
|
type
|
properties.groups.items.properties.mappedToOxygen.type | string | |
|
type
|
properties.groups.items.properties.minUserCount.type | string | |
|
type
|
properties.groups.items.properties.restrictIp.type | string | |
|
type
|
properties.groups.items.properties.shortName.type | string | |
|
type
|
properties.groups.items.properties.urn.type | string | |
|
required
|
properties.groups.items.required | array of string | |
|
type
|
properties.groups.items.type | string | |
|
type
|
properties.groups.type | string | |
|
type
|
type | string |
Lista de permisos
Recupera una lista de todos los permisos disponibles en el inquilino.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.permissions.items.properties.deleted.type | string | |
|
type
|
properties.permissions.items.properties.link.type | string | |
|
type
|
properties.permissions.items.properties.name.type | string | |
|
type
|
properties.permissions.items.properties.title.type | string | |
|
type
|
properties.permissions.items.properties.urn.type | string | |
|
required
|
properties.permissions.items.required | array of string | |
|
type
|
properties.permissions.items.type | string | |
|
type
|
properties.permissions.type | string | |
|
type
|
type | string |
Lista de pestañas de elementos del área de trabajo
Recupera una lista de todas las pestañas configuradas para un área de trabajo específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que se va a recuperar la lista de pestañas.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar una lista de pestañas, se puede obtener a través de la llamada a GET Item List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.tabs.items.properties.name.type | string | |
|
sectionCounts
|
properties.tabs.items.properties.sectionCounts | object | |
|
type
|
properties.tabs.items.properties.totalCount.type | string | |
|
required
|
properties.tabs.items.required | array of string | |
|
type
|
properties.tabs.items.type | string | |
|
type
|
properties.tabs.type | string | |
|
type
|
type | string |
Lista de scripts
Recupera una lista de todos los scripts del inquilino.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el campo para ordenar los resultados.
|
orderBy | string |
Especifica el campo por el que se deben ordenar los resultados. Por ejemplo, el uso de "scriptType" ordenará los resultados en función del tipo de script. Este parámetro funciona junto con "asc" o "desc" para definir la dirección de ordenación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.scripts.items.properties.__self__.type | string | |
|
type
|
properties.scripts.items.properties.dependsOn.items.properties.deleted.type | string | |
|
type
|
properties.scripts.items.properties.dependsOn.items.properties.link.type | string | |
|
type
|
properties.scripts.items.properties.dependsOn.items.properties.title.type | string | |
|
type
|
properties.scripts.items.properties.dependsOn.items.properties.urn.type | string | |
|
required
|
properties.scripts.items.properties.dependsOn.items.required | array of string | |
|
type
|
properties.scripts.items.properties.dependsOn.items.type | string | |
|
type
|
properties.scripts.items.properties.dependsOn.type | string | |
|
type
|
properties.scripts.items.properties.displayName.type | string | |
|
type
|
properties.scripts.items.properties.scriptType.type | string | |
|
type
|
properties.scripts.items.properties.uniqueName.type | string | |
|
type
|
properties.scripts.items.properties.urn.type | string | |
|
type
|
properties.scripts.items.properties.version.type | string | |
|
required
|
properties.scripts.items.required | array of string | |
|
type
|
properties.scripts.items.type | string | |
|
type
|
properties.scripts.type | string | |
|
type
|
type | string |
Lista de secciones de elementos
Recupera una lista de todas las secciones de la pestaña Detalles del elemento.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar secciones de detalles de elementos.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar la configuración de las secciones de detalles del elemento, se puede obtener a través de la llamada a GET Workspace List API. |
Devoluciones
- Productos
- 200_sections
Lista de usuarios
Recupera una lista de todos los usuarios del inquilino con la opción de filtrar por estado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Indica si solo se muestran los usuarios activos.
|
activeOnly | string |
Si se establece en true, muestra solo los usuarios que están activos actualmente. |
|
|
mappedOnly
|
mappedOnly | string |
Si se establece en true, muestra solo los usuarios que están asignadosOnly |
|
|
Ordena los resultados alfabéticamente en orden ascendente o descendente.
|
sort | string |
Ordena los resultados alfabéticamente ascendentes o descendentes en función del valor especificado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.users.items.properties.deleted.type | string | |
|
type
|
properties.users.items.properties.link.type | string | |
|
type
|
properties.users.items.properties.title.type | string | |
|
type
|
properties.users.items.properties.urn.type | string | |
|
required
|
properties.users.items.required | array of string | |
|
type
|
properties.users.items.type | string | |
|
type
|
properties.users.type | string | |
|
type
|
type | string |
Lista de usuarios de permisos
Recupera una lista de todos los permisos asignados a un usuario específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del usuario para el que se van a recuperar los detalles.
|
UserID | True | string |
El identificador del usuario para el que desea recuperar los detalles se puede obtener a través de la llamada a GET Users List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.permissions.items.properties.deleted.type | string | |
|
type
|
properties.permissions.items.properties.link.type | string | |
|
type
|
properties.permissions.items.properties.name.type | string | |
|
type
|
properties.permissions.items.properties.title.type | string | |
|
type
|
properties.permissions.items.properties.urn.type | string | |
|
required
|
properties.permissions.items.required | array of string | |
|
type
|
properties.permissions.items.type | string | |
|
type
|
properties.permissions.type | string | |
|
type
|
type | string |
Lista de vistas configuradas para áreas de trabajo
Recupera una lista de todas las vistas configuradas para un área de trabajo específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene la vista configurada.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene la vista configurada se puede obtener a través de la llamada a get Workspace List API. |
|
Especifica el identificador de un elemento dentro del área de trabajo.
|
ItemID | True | integer |
El identificador de un elemento dentro del área de trabajo se puede obtener a través de la llamada a get Item List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
items.properties.deleted.type | string | |
|
type
|
items.properties.link.type | string | |
|
type
|
items.properties.title.type | string | |
|
type
|
items.properties.urn.type | string | |
|
required
|
items.required | array of string | |
|
type
|
items.type | string | |
|
type
|
type | string |
Lista de áreas de trabajo
Recupera una lista de todas las áreas de trabajo del inquilino.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el número máximo de elementos que se van a devolver en la respuesta.
|
limit | string |
Especifica el número máximo de elementos que se van a devolver en la respuesta. Se usa para limitar el tamaño del conjunto de resultados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.category.properties.displayOrder.type | string | |
|
type
|
properties.items.items.properties.category.properties.icon.type | string | |
|
type
|
properties.items.items.properties.category.properties.name.type | string | |
|
type
|
properties.items.items.properties.category.type | string | |
|
type
|
properties.items.items.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.displayOrder.type | string | |
|
type
|
properties.items.items.properties.link.type | string | |
|
type
|
properties.items.items.properties.permissions.items.type | string | |
|
type
|
properties.items.items.properties.permissions.type | string | |
|
type
|
properties.items.items.properties.systemName.type | string | |
|
type
|
properties.items.items.properties.title.type | string | |
|
type
|
properties.items.items.properties.urn.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Lista printView de elementos
Recupera una lista de vistas de impresión disponibles.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar la lista de vistas de impresión.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea imprimir la lista de vistas se puede obtener a través de la llamada a GET Workspace List API. |
|
Indica si se deben ordenar los resultados en orden ascendente.
|
asc | string |
Indica si los resultados deben ordenarse en orden ascendente. Use "true" para ascendente o déjelo en blanco para la ordenación predeterminada. |
|
|
Indica si se deben ordenar los resultados en orden descendente.
|
desc | string |
Indica si los resultados deben ordenarse en orden descendente. Use "true" para descendente o déjelo en blanco para la ordenación predeterminada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.links.items.properties.deleted.type | string | |
|
type
|
properties.links.items.properties.hidden.type | string | |
|
type
|
properties.links.items.properties.link.type | string | |
|
type
|
properties.links.items.properties.title.type | string | |
|
type
|
properties.links.items.properties.type.type | string | |
|
type
|
properties.links.items.properties.urn.type | string | |
|
required
|
properties.links.items.required | array of string | |
|
type
|
properties.links.items.type | string | |
|
type
|
properties.links.type | string | |
|
type
|
type | string |
Lista relaciones de elementos
Recupera una lista de todos los elementos de relación asociados a un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que contiene la pestaña relaciones.
|
ItemID | True | integer |
El identificador del elemento que contiene la pestaña de relaciones se puede obtener a través de la llamada a la API GET Item List. |
Devoluciones
Nivel de acceso basado en vistas de usuario
Recupera una lista de todas las vistas de usuario (filtro realizado por el usuario de elementos dentro de un área de trabajo).
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene las vistas de usuario.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene las vistas de usuario se puede obtener a través de la llamada a GET Workspace List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.links.items.properties.deleted.type | string | |
|
type
|
properties.links.items.properties.link.type | string | |
|
type
|
properties.links.items.properties.title.type | string | |
|
type
|
properties.links.items.properties.urn.type | string | |
|
required
|
properties.links.items.required | array of string | |
|
type
|
properties.links.items.type | string | |
|
type
|
properties.links.type | string | |
|
type
|
type | string |
Registro de cambios de elemento
Recupera información detallada sobre los cambios realizados en un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para recuperar un registro.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar un registro de se puede obtener a través de la llamada a get Item List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.__self__.type | string | |
|
longName
|
properties.items.items.properties.action.properties.longName | object | |
|
type
|
properties.items.items.properties.action.properties.notifyPermission.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.action.properties.notifyPermission.properties.link.type | string | |
|
type
|
properties.items.items.properties.action.properties.notifyPermission.properties.title.type | string | |
|
type
|
properties.items.items.properties.action.properties.notifyPermission.properties.urn.type | string | |
|
type
|
properties.items.items.properties.action.properties.notifyPermission.type | string | |
|
type
|
properties.items.items.properties.action.properties.shortName.type | string | |
|
type
|
properties.items.items.properties.action.type | string | |
|
type
|
properties.items.items.properties.actionInvoker.type | string | |
|
type
|
properties.items.items.properties.description.type | string | |
|
fieldName
|
properties.items.items.properties.details.items.properties.fieldName | object | |
|
type
|
properties.items.items.properties.details.items.properties.newValue.type | string | |
|
oldValue
|
properties.items.items.properties.details.items.properties.oldValue | object | |
|
type
|
properties.items.items.properties.details.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.details.items.properties.type.properties.link.type | string | |
|
type
|
properties.items.items.properties.details.items.properties.type.properties.urn.type | string | |
|
type
|
properties.items.items.properties.details.items.properties.type.type | string | |
|
required
|
properties.items.items.properties.details.items.required | array of string | |
|
type
|
properties.items.items.properties.details.items.type | string | |
|
type
|
properties.items.items.properties.details.type | string | |
|
type
|
properties.items.items.properties.timeStamp.type | string | |
|
type
|
properties.items.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.user.properties.email.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.large.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.medium.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.small.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.type | string | |
|
type
|
properties.items.items.properties.user.properties.link.type | string | |
|
type
|
properties.items.items.properties.user.properties.status.type | string | |
|
type
|
properties.items.items.properties.user.properties.title.type | string | |
|
type
|
properties.items.items.properties.user.properties.urn.type | string | |
|
type
|
properties.items.items.properties.user.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.next.properties.count.type | string | |
|
type
|
properties.next.properties.deleted.type | string | |
|
type
|
properties.next.properties.link.type | string | |
|
type
|
properties.next.properties.title.type | string | |
|
type
|
properties.next.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Registro de elementos
Recupera información detallada del registro de un elemento específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para el que se va a recuperar un registro.
|
ItemID | True | integer |
El identificador del elemento para el que desea recuperar un registro de se puede obtener a través de la llamada a get Item List API. |
|
Especifica el índice inicial para recuperar elementos en un conjunto de resultados paginado.
|
offset | string |
Especifica el punto de partida o el índice desde el que se van a recuperar elementos de un conjunto de resultados paginado. Resulta útil para omitir un número determinado de elementos de la lista. |
|
|
Especifica el número máximo de elementos que se van a devolver en la respuesta.
|
limit | string |
Especifica el número máximo de elementos que se van a devolver en la respuesta. Se usa para limitar el tamaño del conjunto de resultados. |
|
|
Especifica el campo para ordenar los resultados en orden ascendente.
|
asc | string |
Especifica el campo por el que se deben ordenar los resultados en orden ascendente. Por ejemplo, el uso de "timeStamp" ordenará los resultados en función de la hora en que se crearon o modificaron. |
|
|
Especifica el campo para ordenar los resultados en orden descendente.
|
desc | string |
Especifica el campo por el que se deben ordenar los resultados en orden descendente. Por ejemplo, el uso de "timeStamp" ordenará los resultados en función de la hora en que se crearon o modificaron. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.__self__.type | string | |
|
longName
|
properties.items.items.properties.action.properties.longName | object | |
|
notifyPermission
|
properties.items.items.properties.action.properties.notifyPermission | object | |
|
type
|
properties.items.items.properties.action.properties.shortName.type | string | |
|
type
|
properties.items.items.properties.action.type | string | |
|
type
|
properties.items.items.properties.actionInvoker.type | string | |
|
type
|
properties.items.items.properties.description.type | string | |
|
type
|
properties.items.items.properties.details.type | string | |
|
type
|
properties.items.items.properties.timeStamp.type | string | |
|
type
|
properties.items.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.user.properties.email.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.large.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.medium.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.properties.small.type | string | |
|
type
|
properties.items.items.properties.user.properties.image.type | string | |
|
type
|
properties.items.items.properties.user.properties.link.type | string | |
|
type
|
properties.items.items.properties.user.properties.status.type | string | |
|
type
|
properties.items.items.properties.user.properties.title.type | string | |
|
type
|
properties.items.items.properties.user.properties.urn.type | string | |
|
type
|
properties.items.items.properties.user.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.next.properties.count.type | string | |
|
type
|
properties.next.properties.deleted.type | string | |
|
type
|
properties.next.properties.link.type | string | |
|
type
|
properties.next.properties.title.type | string | |
|
type
|
properties.next.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Tipos de campo de elemento
Proporciona una lista de todos los tipos de campo disponibles.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.field-types.items.properties.deleted.type | string | |
|
type
|
properties.field-types.items.properties.link.type | string | |
|
type
|
properties.field-types.items.properties.title.type | string | |
|
type
|
properties.field-types.items.properties.urn.type | string | |
|
required
|
properties.field-types.items.required | array of string | |
|
type
|
properties.field-types.items.type | string | |
|
type
|
properties.field-types.type | string | |
|
type
|
type | string |
Trabajo pendiente del usuario
Recupera el trabajo pendiente para el usuario que ha iniciado sesión a través de la API. El @me parámetro se usa para hacer referencia al usuario que ha iniciado sesión actualmente y no es posible elegir otro usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del usuario para recuperar los detalles.
|
UserID | True | string |
El identificador del usuario para el que desea recuperar los detalles se puede obtener a través de la llamada a GET Users List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.count.type | string | |
|
type
|
properties.lastRecalculateStarted.type | string | |
|
type
|
properties.lastRecalculateUpdate.type | string | |
|
type
|
properties.outstandingWork.items.properties.delegated.type | string | |
|
type
|
properties.outstandingWork.items.properties.escalated.type | string | |
|
type
|
properties.outstandingWork.items.properties.item.properties.deleted.type | string | |
|
type
|
properties.outstandingWork.items.properties.item.properties.link.type | string | |
|
type
|
properties.outstandingWork.items.properties.item.properties.title.type | string | |
|
type
|
properties.outstandingWork.items.properties.item.properties.urn.type | string | |
|
type
|
properties.outstandingWork.items.properties.item.type | string | |
|
type
|
properties.outstandingWork.items.properties.milestoneDate.type | string | |
|
type
|
properties.outstandingWork.items.properties.milestoneStatus.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowStateName.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowStateSetDate.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.email.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.large.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.medium.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.small.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.image.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.link.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.status.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.title.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.properties.urn.type | string | |
|
type
|
properties.outstandingWork.items.properties.workflowUser.type | string | |
|
type
|
properties.outstandingWork.items.properties.workspace.properties.deleted.type | string | |
|
type
|
properties.outstandingWork.items.properties.workspace.properties.link.type | string | |
|
type
|
properties.outstandingWork.items.properties.workspace.properties.title.type | string | |
|
type
|
properties.outstandingWork.items.properties.workspace.properties.type.type | string | |
|
type
|
properties.outstandingWork.items.properties.workspace.properties.urn.type | string | |
|
type
|
properties.outstandingWork.items.properties.workspace.type | string | |
|
required
|
properties.outstandingWork.items.required | array of string | |
|
type
|
properties.outstandingWork.items.type | string | |
|
type
|
properties.outstandingWork.type | string | |
|
type
|
properties.recalculating.type | string | |
|
type
|
type | string |
Transiciones de lista de áreas de trabajo
Recupera una lista de transiciones disponibles para un área de trabajo específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar la lista de transición.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar una lista de la transición se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador de un elemento dentro del área de trabajo.
|
ItemID | True | integer |
El identificador de un elemento dentro del área de trabajo se puede obtener a través de la llamada a get Item List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
items.properties.__self__.type | string | |
|
type
|
items.properties.actionScript.properties.deleted.type | string | |
|
type
|
items.properties.actionScript.properties.link.type | string | |
|
type
|
items.properties.actionScript.properties.title.type | string | |
|
type
|
items.properties.actionScript.properties.urn.type | string | |
|
type
|
items.properties.actionScript.type | string | |
|
type
|
items.properties.approvers.type | string | |
|
type
|
items.properties.comments.type | string | |
|
type
|
items.properties.customLabel.type | string | |
|
type
|
items.properties.delegatorUsers.type | string | |
|
type
|
items.properties.escalationPermission.properties.deleted.type | string | |
|
type
|
items.properties.escalationPermission.properties.link.type | string | |
|
type
|
items.properties.escalationPermission.properties.title.type | string | |
|
type
|
items.properties.escalationPermission.properties.urn.type | string | |
|
type
|
items.properties.escalationPermission.type | string | |
|
type
|
items.properties.fromState.properties.deleted.type | string | |
|
type
|
items.properties.fromState.properties.link.type | string | |
|
type
|
items.properties.fromState.properties.title.type | string | |
|
type
|
items.properties.fromState.properties.urn.type | string | |
|
type
|
items.properties.fromState.type | string | |
|
type
|
items.properties.hidden.type | string | |
|
type
|
items.properties.ignoreEscalatedPreconditions.type | string | |
|
type
|
items.properties.labelPositionA.type | string | |
|
type
|
items.properties.labelPositionB.type | string | |
|
type
|
items.properties.name.type | string | |
|
type
|
items.properties.notifyPerformers.type | string | |
|
type
|
items.properties.passwordEnabled.type | string | |
|
type
|
items.properties.permission.properties.deleted.type | string | |
|
type
|
items.properties.permission.properties.link.type | string | |
|
type
|
items.properties.permission.properties.title.type | string | |
|
type
|
items.properties.permission.properties.urn.type | string | |
|
type
|
items.properties.permission.type | string | |
|
Puntos
|
items.properties.points | object | |
|
type
|
items.properties.sendEmail.type | string | |
|
type
|
items.properties.showInOutstanding.type | string | |
|
type
|
items.properties.toState.properties.deleted.type | string | |
|
type
|
items.properties.toState.properties.link.type | string | |
|
type
|
items.properties.toState.properties.title.type | string | |
|
type
|
items.properties.toState.properties.urn.type | string | |
|
type
|
items.properties.toState.type | string | |
|
type
|
items.properties.urn.type | string | |
|
type
|
items.properties.workspace.properties.deleted.type | string | |
|
type
|
items.properties.workspace.properties.link.type | string | |
|
type
|
items.properties.workspace.properties.title.type | string | |
|
type
|
items.properties.workspace.properties.type.type | string | |
|
type
|
items.properties.workspace.properties.urn.type | string | |
|
type
|
items.properties.workspace.type | string | |
|
required
|
items.required | array of string | |
|
type
|
items.type | string | |
|
type
|
type | string |
Transiciones disponibles
Recupera una lista de transiciones disponibles para un elemento específico basado en el usuario que ha iniciado sesión.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo para recuperar las transiciones disponibles.
|
WorkspaceID | True | integer |
El identificador del área de trabajo para la que desea recuperar una lista de transiciones disponibles, se puede obtener a través de la llamada a GET Workspace List API. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
items.properties.__self__.type | string | |
|
type
|
items.properties.actionScript.properties.deleted.type | string | |
|
type
|
items.properties.actionScript.properties.link.type | string | |
|
type
|
items.properties.actionScript.properties.title.type | string | |
|
type
|
items.properties.actionScript.properties.urn.type | string | |
|
type
|
items.properties.actionScript.type | string | |
|
Aprobadores
|
items.properties.approvers | array of string | |
|
type
|
items.properties.comments.type | string | |
|
type
|
items.properties.conditionScript.properties.deleted.type | string | |
|
type
|
items.properties.conditionScript.properties.link.type | string | |
|
type
|
items.properties.conditionScript.properties.title.type | string | |
|
type
|
items.properties.conditionScript.properties.urn.type | string | |
|
type
|
items.properties.conditionScript.type | string | |
|
type
|
items.properties.customLabel.type | string | |
|
delegatorUsers
|
items.properties.delegatorUsers | array of string | |
|
type
|
items.properties.escalationPermission.properties.deleted.type | string | |
|
type
|
items.properties.escalationPermission.properties.link.type | string | |
|
type
|
items.properties.escalationPermission.properties.title.type | string | |
|
type
|
items.properties.escalationPermission.properties.urn.type | string | |
|
type
|
items.properties.escalationPermission.type | string | |
|
type
|
items.properties.fromState.properties.deleted.type | string | |
|
type
|
items.properties.fromState.properties.link.type | string | |
|
type
|
items.properties.fromState.properties.title.type | string | |
|
type
|
items.properties.fromState.properties.urn.type | string | |
|
type
|
items.properties.fromState.type | string | |
|
type
|
items.properties.hidden.type | string | |
|
type
|
items.properties.ignoreEscalatedPreconditions.type | string | |
|
type
|
items.properties.labelPositionA.type | string | |
|
type
|
items.properties.labelPositionB.type | string | |
|
type
|
items.properties.name.type | string | |
|
type
|
items.properties.notifyPerformers.type | string | |
|
type
|
items.properties.passwordEnabled.type | string | |
|
type
|
items.properties.permission.properties.deleted.type | string | |
|
type
|
items.properties.permission.properties.link.type | string | |
|
type
|
items.properties.permission.properties.title.type | string | |
|
type
|
items.properties.permission.properties.urn.type | string | |
|
type
|
items.properties.permission.type | string | |
|
Puntos
|
items.properties.points | object | |
|
type
|
items.properties.sendEmail.type | string | |
|
type
|
items.properties.showInOutstanding.type | string | |
|
type
|
items.properties.toState.properties.deleted.type | string | |
|
type
|
items.properties.toState.properties.link.type | string | |
|
type
|
items.properties.toState.properties.title.type | string | |
|
type
|
items.properties.toState.properties.urn.type | string | |
|
type
|
items.properties.toState.type | string | |
|
type
|
items.properties.urn.type | string | |
|
type
|
items.properties.validationScript.properties.deleted.type | string | |
|
type
|
items.properties.validationScript.properties.link.type | string | |
|
type
|
items.properties.validationScript.properties.title.type | string | |
|
type
|
items.properties.validationScript.properties.urn.type | string | |
|
type
|
items.properties.validationScript.type | string | |
|
type
|
items.properties.workspace.properties.deleted.type | string | |
|
type
|
items.properties.workspace.properties.link.type | string | |
|
type
|
items.properties.workspace.properties.title.type | string | |
|
type
|
items.properties.workspace.properties.type.type | string | |
|
type
|
items.properties.workspace.properties.urn.type | string | |
|
type
|
items.properties.workspace.type | string | |
|
required
|
items.required | array of string | |
|
type
|
items.type | string | |
|
type
|
type | string |
Transición de elemento
Realiza una transición en un elemento específico. Devuelve 403 incluso cuando se ejecuta correctamente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento para realizar una transición.
|
ItemID | True | integer |
El identificador del elemento en el que desea realizar una transición, se puede obtener a través de la llamada a get Item List API. |
|
Especifica el identificador de la transición de flujo de trabajo que se va a realizar.
|
WorkflowID | True | integer |
Identificador de la transición de flujo de trabajo que desea realizar. |
|
Especifica la ubicación del recurso o el contenido.
|
content-location | True | string |
Especifica la ubicación del recurso o el contenido. Debe ser una dirección URL o ruta de acceso válida a la que se hospeda o se recupera el contenido. |
|
request123
|
request123 |
Usuarios en grupo
Recupera una lista de usuarios y sus detalles para un grupo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del grupo para el que se van a recuperar los detalles.
|
GroupID | True | integer |
El identificador del grupo para el que desea recuperar los detalles se puede obtener a través de la llamada a la API GET Groups List. |
|
Especifica el índice inicial para recuperar elementos en un conjunto de resultados paginado.
|
offset | string |
Especifica el punto de partida o el índice desde el que se van a recuperar elementos de un conjunto de resultados paginado. Resulta útil para omitir un número determinado de elementos de la lista. |
|
|
Especifica el número máximo de elementos que se van a devolver en la respuesta.
|
limit | string |
Especifica el número máximo de elementos que se van a devolver en la respuesta. Se usa para limitar el tamaño del conjunto de resultados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.__self__.type | string | |
|
aboutMe
|
properties.items.items.properties.aboutMe | object | |
|
type
|
properties.items.items.properties.active.type | string | |
|
type
|
properties.items.items.properties.address1.type | string | |
|
type
|
properties.items.items.properties.address2.type | string | |
|
type
|
properties.items.items.properties.analyticsId.type | string | |
|
type
|
properties.items.items.properties.batchNotifyPref.type | string | |
|
type
|
properties.items.items.properties.cellular.type | string | |
|
type
|
properties.items.items.properties.city.type | string | |
|
type
|
properties.items.items.properties.consumeLicense.type | string | |
|
type
|
properties.items.items.properties.country.type | string | |
|
dashboardCharts
|
properties.items.items.properties.dashboardCharts | object | |
|
type
|
properties.items.items.properties.dateFormat.type | string | |
|
Delegaciones
|
properties.items.items.properties.delegations | array of string | |
|
type
|
properties.items.items.properties.displayName.type | string | |
|
type
|
properties.items.items.properties.displayNameExtended.type | string | |
|
type
|
properties.items.items.properties.email.type | string | |
|
type
|
properties.items.items.properties.enforce2fa.type | string | |
|
type
|
properties.items.items.properties.entitlement.type | string | |
|
externalAuthReservationToken
|
properties.items.items.properties.externalAuthReservationToken | object | |
|
type
|
properties.items.items.properties.externalAuthUserId.type | string | |
|
type
|
properties.items.items.properties.fax.type | string | |
|
type
|
properties.items.items.properties.firstName.type | string | |
|
type
|
properties.items.items.properties.id.type | string | |
|
industria
|
properties.items.items.properties.industry | object | |
|
type
|
properties.items.items.properties.interfaceStyle.type | string | |
|
type
|
properties.items.items.properties.interfaceStyleMandated.type | string | |
|
type
|
properties.items.items.properties.lastAccessTime.type | string | |
|
type
|
properties.items.items.properties.lastLicenseTimeIssued.type | string | |
|
type
|
properties.items.items.properties.lastLoginTime.type | string | |
|
type
|
properties.items.items.properties.lastMowUpdateDate.type | string | |
|
type
|
properties.items.items.properties.lastName.type | string | |
|
type
|
properties.items.items.properties.lastRecalculateStarted.type | string | |
|
type
|
properties.items.items.properties.lastRecalculateUpdate.type | string | |
|
type
|
properties.items.items.properties.ldapEnabled.type | string | |
|
type
|
properties.items.items.properties.licenseFeatureId.type | string | |
|
type
|
properties.items.items.properties.licenseType.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.licenseType.properties.description.type | string | |
|
type
|
properties.items.items.properties.licenseType.properties.link.type | string | |
|
type
|
properties.items.items.properties.licenseType.properties.title.type | string | |
|
type
|
properties.items.items.properties.licenseType.properties.type.type | string | |
|
type
|
properties.items.items.properties.licenseType.properties.urn.type | string | |
|
type
|
properties.items.items.properties.licenseType.type | string | |
|
type
|
properties.items.items.properties.loginName.type | string | |
|
type
|
properties.items.items.properties.mappedToOxygen.type | string | |
|
type
|
properties.items.items.properties.organization.type | string | |
|
type
|
properties.items.items.properties.phone.type | string | |
|
type
|
properties.items.items.properties.plmSearchCrawlerUser.type | string | |
|
type
|
properties.items.items.properties.postal.type | string | |
|
type
|
properties.items.items.properties.regularUser.type | string | |
|
type
|
properties.items.items.properties.reset.type | string | |
|
signupUrl
|
properties.items.items.properties.signupUrl | object | |
|
type
|
properties.items.items.properties.stateProv.type | string | |
|
surveyDone
|
properties.items.items.properties.surveyDone | object | |
|
type
|
properties.items.items.properties.tenantAdmin.type | string | |
|
type
|
properties.items.items.properties.thumbnailPref.type | string | |
|
type
|
properties.items.items.properties.timezone.type | string | |
|
type
|
properties.items.items.properties.title.type | string | |
|
type
|
properties.items.items.properties.twoFactorAuthEnabled.type | string | |
|
type
|
properties.items.items.properties.uomPref.type | string | |
|
type
|
properties.items.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.userActive.type | string | |
|
type
|
properties.items.items.properties.userId.type | string | |
|
type
|
properties.items.items.properties.userInactive.type | string | |
|
type
|
properties.items.items.properties.userNumber.type | string | |
|
type
|
properties.items.items.properties.userStatus.type | string | |
|
type
|
properties.items.items.properties.wfNotifyPref.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Valor de búsqueda en todo el inquilino
Busca un valor en todos los elementos del inquilino completo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el término de búsqueda para consultar datos de inquilino.
|
query | string |
Término de búsqueda que se va a usar para consultar los datos del inquilino. |
|
|
Especifica el número máximo de elementos que se van a devolver en la respuesta.
|
limit | string |
Especifica el número máximo de elementos que se van a devolver en la respuesta. Se usa para limitar el tamaño del conjunto de resultados. |
|
|
Especifica el criterio de ordenación de los resultados.
|
sort | string |
Especifica el criterio de ordenación de los resultados. Use "asc" para ascendente y "desc" para descendente. Ejemplo: 'createdOn asc' para ordenar por fecha de creación en orden ascendente. |
|
|
Especifica el tipo de medio esperado en la respuesta.
|
Accept | string |
Especifica el tipo de medio que el cliente espera en la respuesta. En este caso, el cliente solicita que la respuesta esté en formato de datos de elementos masivos en formato JSON. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
properties.__self__.type | string | |
|
type
|
properties.first.properties.count.type | string | |
|
type
|
properties.first.properties.deleted.type | string | |
|
type
|
properties.first.properties.link.type | string | |
|
type
|
properties.first.properties.title.type | string | |
|
type
|
properties.first.type | string | |
|
type
|
properties.items.items.properties.__self__.type | string | |
|
type
|
properties.items.items.properties.audit.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.audit.properties.link.type | string | |
|
type
|
properties.items.items.properties.audit.type | string | |
|
type
|
properties.items.items.properties.bom.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.bom.properties.link.type | string | |
|
type
|
properties.items.items.properties.bom.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.link.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.title.type | string | |
|
type
|
properties.items.items.properties.currentState.properties.urn.type | string | |
|
type
|
properties.items.items.properties.currentState.type | string | |
|
type
|
properties.items.items.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.flatBom.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.flatBom.properties.link.type | string | |
|
type
|
properties.items.items.properties.flatBom.type | string | |
|
type
|
properties.items.items.properties.itemLocked.type | string | |
|
type
|
properties.items.items.properties.latestRelease.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.link.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.title.type | string | |
|
type
|
properties.items.items.properties.lifecycle.properties.urn.type | string | |
|
type
|
properties.items.items.properties.lifecycle.type | string | |
|
type
|
properties.items.items.properties.milestones.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.milestones.properties.link.type | string | |
|
type
|
properties.items.items.properties.milestones.type | string | |
|
type
|
properties.items.items.properties.nestedBom.properties.count.type | string | |
|
type
|
properties.items.items.properties.nestedBom.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.nestedBom.properties.link.type | string | |
|
type
|
properties.items.items.properties.nestedBom.type | string | |
|
type
|
properties.items.items.properties.owners.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.owners.properties.link.type | string | |
|
type
|
properties.items.items.properties.owners.type | string | |
|
type
|
properties.items.items.properties.root.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.root.properties.link.type | string | |
|
type
|
properties.items.items.properties.root.properties.title.type | string | |
|
type
|
properties.items.items.properties.root.properties.urn.type | string | |
|
type
|
properties.items.items.properties.root.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.title.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.items.items.properties.sections.items.properties.fields.items.required | array of string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.items.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.fields.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.link.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.sectionLocked.type | string | |
|
type
|
properties.items.items.properties.sections.items.properties.title.type | string | |
|
required
|
properties.items.items.properties.sections.items.required | array of string | |
|
type
|
properties.items.items.properties.sections.items.type | string | |
|
type
|
properties.items.items.properties.sections.type | string | |
|
type
|
properties.items.items.properties.sectionsLink.type | string | |
|
type
|
properties.items.items.properties.title.type | string | |
|
type
|
properties.items.items.properties.urn.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.count.properties.type.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.count.properties.value.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.count.type | string | |
|
type
|
properties.items.items.properties.whereUsed.properties.link.type | string | |
|
type
|
properties.items.items.properties.whereUsed.type | string | |
|
type
|
properties.items.items.properties.workflowReference.type | string | |
|
type
|
properties.items.items.properties.workingHasChanged.type | string | |
|
type
|
properties.items.items.properties.workingVersion.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.deleted.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.link.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.title.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.type.type | string | |
|
type
|
properties.items.items.properties.workspace.properties.urn.type | string | |
|
type
|
properties.items.items.properties.workspace.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
type
|
properties.items.items.type | string | |
|
type
|
properties.items.type | string | |
|
type
|
properties.last.properties.count.type | string | |
|
type
|
properties.last.properties.deleted.type | string | |
|
type
|
properties.last.properties.link.type | string | |
|
type
|
properties.last.properties.title.type | string | |
|
type
|
properties.last.type | string | |
|
type
|
properties.limit.type | string | |
|
type
|
properties.offset.type | string | |
|
type
|
properties.totalCount.type | string | |
|
type
|
type | string |
Versión de creación de datos adjuntos
Crea una nueva versión de los datos adjuntos existentes.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Especifica el identificador del área de trabajo que contiene el elemento.
|
WorkspaceID | True | integer |
El identificador del área de trabajo que contiene el elemento se puede obtener a través de la llamada a GET Workspace List API. |
|
Especifica el identificador del elemento que contiene los datos adjuntos.
|
ItemID | True | integer |
El identificador del elemento que contiene los datos adjuntos se puede obtener a través de la llamada a get Item List API. |
|
Especifica el identificador de los datos adjuntos para crear una nueva versión.
|
AttachmentID | True | integer |
El identificador de los datos adjuntos para los que desea crear una nueva versión se puede obtener a través de la llamada a la API GET Attachments List. |
|
Indica el tipo de medio del cuerpo de la solicitud.
|
Content-Type | string |
Indica el tipo de medio del cuerpo de la solicitud. En este caso, se espera que el cuerpo de la solicitud esté en formato JSON. |
|
|
request123
|
request123 |
Definiciones
200_sections
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
nombre
|
name | string | |
|
descripción
|
description | string | |
|
type
|
type | string | |
|
displayOrder
|
displayOrder | integer | |
|
sectionType
|
sectionType | string | |
|
fields
|
fields | array of object | |
|
link
|
fields.link | string | |
|
urna
|
fields.urn | string | |
|
title
|
fields.title | string | |
|
eliminado
|
fields.deleted | boolean | |
|
type
|
fields.type | string | |
|
sectionLocked
|
sectionLocked | boolean | |
|
pimSection
|
pimSection | boolean | |
|
__propio__
|
__self__ | string | |
|
urna
|
urn | string | |
|
matrices
|
matrices | array of object | |
|
__propio__
|
matrices.__self__ | string | |
|
urna
|
matrices.urn | string | |
|
Ancho
|
matrices.width | integer | |
|
altura
|
matrices.height | integer | |
|
columnNames
|
matrices.columnNames | array of string | |
|
rowNames
|
matrices.rowNames | array of string | |
|
fields
|
matrices.fields | array of array | |
|
items
|
matrices.fields | array of object | |
|
link
|
matrices.fields.link | string | |
|
urna
|
matrices.fields.urn | string | |
|
title
|
matrices.fields.title | string | |
|
eliminado
|
matrices.fields.deleted | boolean | |
|
type
|
matrices.fields.type | string |
ApiV3Workspaces-WorkspaceID-Items:ItemID-Views10Get200ApplicationJsonResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Productos
|
string |