Fuxsy-ADSKFusionManagePaid (Editora Independente) (Pré-visualização)
Para mais informações, visite: www.fuxsy.eu
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Fuxsy s.r.o. |
| URL | http://fuxsy.eu/ |
| support@fuxsy.eu |
| Metadados do conector | |
|---|---|
| Editora | Fuxsy.eu |
| Sítio Web | http://fuxsy.eu/ |
| Política de privacidade | http://fuxsy.eu/ |
| Categorias | Dados;Operações de TI |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualização da linha da grade de itens |
Atualiza uma ou mais linhas para um item específico. |
| Campos da Lista de Itens |
Recupera uma lista de todos os campos dentro da grade. |
| Criar anexo |
Cria ou carrega um novo anexo para um item específico. |
| Criar itens gerenciados por item |
Associa um novo item gerenciado a um item específico. |
| Criar linha de item |
Cria uma nova linha para um item específico dentro da grade. |
| Criar pasta de anexos |
Cria uma nova pasta de anexo para um item específico. |
| Criação de Item |
Cria um novo item dentro de um espaço de trabalho específico. |
| Detalhes da atualização do item |
Atualiza os detalhes de um item específico, removendo todos os detalhes que não são especificados. |
| Detalhes da atualização do item - parcial |
Atualiza parcialmente os detalhes de um item específico, mantendo quaisquer detalhes não especificados. |
| Detalhes da lista de opções |
Recupera detalhes de pesquisas de lista de opções. |
| Detalhes da permissão |
Recupera informações detalhadas sobre uma permissão específica. |
| Detalhes da permissão do usuário |
Recupera os detalhes de permissão para um usuário específico em um espaço de trabalho específico, com base na ID de permissão fornecida. |
| Detalhes da visualização do usuário |
Recupera informações detalhadas sobre a exibição de um usuário específico. |
| Detalhes do anexo |
Recupera informações detalhadas sobre um anexo específico. |
| Detalhes do campo do item |
Exibe informações detalhadas sobre o campo especificado dentro de uma grade de itens. |
| Detalhes do item |
Recupera informações detalhadas sobre um item específico. |
| Detalhes do Relatório |
Recupera os detalhes completos de configuração do relatório. |
| Detalhes do script |
Recupera o conteúdo e os detalhes de um script específico. |
| Detalhes do Utilizador |
Recupera informações detalhadas sobre o usuário especificado. Se @me for usada, a API retornará detalhes sobre o usuário que está fazendo a chamada de API. |
| Detalhes dos Grupos |
Recupera informações detalhadas sobre um grupo específico. |
| Download do relatório |
Recupera informações detalhadas sobre um relatório/baixa o relatório |
| Excelente trabalho do usuário |
Recupera o trabalho pendente para o usuário conectado por meio da API. O @me parâmetro é usado para se referir ao usuário conectado no momento, e não é possível escolher um usuário diferente. |
| Item de Relacionamento Criar Item |
Cria uma nova relação para um item específico. |
| Item onde usado |
Recupera uma lista de onde o item específico é usado. |
|
Item Print |
Gera uma visualização de impressão de um item específico. |
| Itens do espaço de trabalho |
Recupera uma lista de todos os itens em um espaço de trabalho específico. |
| Itens gerenciados por item |
Recupera uma lista de itens gerenciados associados a um item específico. |
| Linhas da grade de itens |
Recupera uma lista de linhas e campos para um item específico, incluindo seus valores. |
| Lista de anexos |
Recupera uma lista de todos os anexos de um item específico. |
| Lista de Campos de Detalhes do Item |
Recupera uma lista de todos os campos disponíveis na guia Detalhes do Item. |
| Lista de espaços de trabalho |
Recupera uma lista de todos os espaços de trabalho no locatário. |
| Lista de exibição configurada para espaço de trabalho |
Recupera uma lista de todos os modos de exibição configurados para um espaço de trabalho específico. |
| Lista de Grupos |
Recupera uma lista de todos os grupos disponíveis no locatário. |
| Lista de Itens Gerenciados |
Recupera uma lista de itens gerenciados associados a um item específico. |
| Lista de permissões |
Recupera uma lista de todas as permissões disponíveis no locatário. |
| Lista de permissões do usuário |
Recupera uma lista de todas as permissões atribuídas a um usuário específico. |
| Lista de Relações de Item |
Recupera uma lista de todos os itens de relacionamento associados a um item específico. |
| Lista de scripts |
Recupera uma lista de todos os scripts dentro do locatário. |
| Lista de separadores de item de espaço de trabalho |
Recupera uma lista de todas as guias configuradas para um espaço de trabalho específico. |
| Lista de Seções de Item |
Recupera uma lista de todas as seções na guia Detalhes do Item. |
| Lista de Utilizadores |
Recupera uma lista de todos os usuários no locatário com a opção de filtrar por status. |
|
Lista Print |
Recupera uma lista de modos de exibição de impressão disponíveis. |
| Nível de acesso baseado em Visualizações do Usuário |
Recupera uma lista de todas as exibições do usuário (filtro feito pelo usuário de itens dentro de um espaço de trabalho). |
| Registo de Alterações de Itens |
Recupera informações detalhadas sobre alterações feitas em um item específico. |
| Registo de Itens |
Recupera informações detalhadas de log para um item específico. |
| Relação do item Detalhe do item V1 |
Recupera uma lista de relações para um item específico. |
| Script Criar Novo |
Cria um novo script do tipo especificado. |
| Tipos de campo de item |
Fornece uma lista de todos os tipos de campo disponíveis. |
| Transição de itens |
Executa uma transição em um item específico. Retorna 403 mesmo quando bem-sucedido. |
| Transições de lista de espaços de trabalho |
Recupera uma lista de transições disponíveis para um espaço de trabalho específico. |
| Transições disponíveis |
Recupera uma lista de transições disponíveis para um item específico com base no usuário conectado. |
| Usuários em grupo |
Recupera uma lista de usuários e seus detalhes para um grupo específico. |
| Valor de pesquisa em todo o locatário |
Procura um valor em todos os itens em todo o locatário. |
| Versão de criação de anexo |
Cria uma nova versão de um anexo existente. |
| Visão geral da guia Itens |
Recupera uma lista de registros e campos para uma guia específica. |
Atualização da linha da grade de itens
Atualiza uma ou mais linhas para um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item que contém a guia de grade.
|
ItemID | True | integer |
A ID do item que contém a guia de grade pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica a ID da linha a ser atualizada.
|
RowID | True | integer |
A ID da linha que você deseja atualizar. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Campos da Lista de Itens
Recupera uma lista de todos os campos dentro da grade.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperação de detalhes do campo de grade.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar os detalhes do campo de grade pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica o tipo de mídia esperado na resposta.
|
Accept | string |
Especifica o tipo de mídia que o cliente espera na resposta. Nesse caso, o cliente solicita que a resposta esteja no formato JSON. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.fields.items.properties.__self__.type | string | |
|
defaultValue
|
properties.fields.items.properties.defaultValue | object | |
|
tipo
|
properties.fields.items.properties.derived.type | string | |
|
tipo
|
properties.fields.items.properties.description.type | string | |
|
tipo
|
properties.fields.items.properties.displayLength.type | string | |
|
tipo
|
properties.fields.items.properties.displayOrder.type | string | |
|
tipo
|
properties.fields.items.properties.editability.type | string | |
|
fieldLength
|
properties.fields.items.properties.fieldLength | object | |
|
fieldPrecision
|
properties.fields.items.properties.fieldPrecision | object | |
|
fieldValidadores
|
properties.fields.items.properties.fieldValidators | object | |
|
tipo
|
properties.fields.items.properties.formulaField.type | string | |
|
propriedades
|
properties.fields.items.properties.gridFieldAggregationInfo.properties | object | |
|
tipo
|
properties.fields.items.properties.gridFieldAggregationInfo.type | string | |
|
etiqueta
|
properties.fields.items.properties.label | object | |
|
tipo
|
properties.fields.items.properties.name.type | string | |
|
tipo
|
properties.fields.items.properties.picklist.type | string | |
|
tipo
|
properties.fields.items.properties.picklistFieldDefinition.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.fields.items.properties.type.type | string | |
|
unidadeDeMedida
|
properties.fields.items.properties.unitOfMeasure | object | |
|
tipo
|
properties.fields.items.properties.urn.type | string | |
|
validadores
|
properties.fields.items.properties.validators | object | |
|
tipo
|
properties.fields.items.properties.visibility.type | string | |
|
visibleOnPreview
|
properties.fields.items.properties.visibleOnPreview | object | |
|
required
|
properties.fields.items.required | array of string | |
|
tipo
|
properties.fields.items.type | string | |
|
tipo
|
properties.fields.type | string | |
|
tipo
|
type | string |
Criar anexo
Cria ou carrega um novo anexo para um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar detalhes.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Workspace List. |
|
Especifica a ID do item para recuperar detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Item List. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Criar itens gerenciados por item
Associa um novo item gerenciado a um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item que contém a guia do item gerenciado.
|
ItemID | True | integer |
A ID do item que contém a guia do item gerenciado pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica o tipo de mídia esperado na resposta.
|
Accept | string |
Especifica o tipo de mídia que o cliente espera na resposta. Nesse caso, o cliente solicita que a resposta esteja no formato de dados de itens afetados em massa no formato JSON. |
|
|
pedido123
|
request123 |
Criar linha de item
Cria uma nova linha para um item específico dentro da grade.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para criar uma linha de grade.
|
ItemID | True | integer |
A ID do item para o qual você deseja criar uma linha de grade pode ser obtida por meio da chamada da API GET Item List. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Criar pasta de anexos
Cria uma nova pasta de anexo para um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item que contém o anexo.
|
ItemID | True | integer |
A ID do item que contém o anexo pode ser obtida por meio da chamada da API GET Item List. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Criação de Item
Cria um novo item dentro de um espaço de trabalho específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para a criação do item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho no qual você deseja criar um item pode ser obtida por meio da chamada da API GET Workspace List. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Detalhes da atualização do item
Atualiza os detalhes de um item específico, removendo todos os detalhes que não são especificados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item a ser atualizado detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja atualizar os detalhes do item pode ser obtida por meio da chamada da API GET Item List. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Detalhes da atualização do item - parcial
Atualiza parcialmente os detalhes de um item específico, mantendo quaisquer detalhes não especificados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item a ser atualizado detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja atualizar os detalhes do item pode ser obtida por meio da chamada da API GET Item List. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Detalhes da lista de opções
Recupera detalhes de pesquisas de lista de opções.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID Personalizada da Lista de Opções/Pesquisa para recuperação de detalhes.
|
PicklistID | True | string |
A ID personalizada da lista de opções/pesquisa para a qual você deseja recuperar detalhes. |
|
Especifica o índice inicial para recuperar itens em um conjunto de resultados paginado.
|
offset | string |
Especifica o ponto de partida ou índice do qual recuperar itens em um conjunto de resultados paginado. Útil para ignorar um determinado número de itens na lista. |
|
|
Especifica o número máximo de itens a serem retornados na resposta.
|
limit | string |
Especifica o número máximo de itens a serem retornados na resposta. Isso é usado para limitar o tamanho do conjunto de resultados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.properties.urn.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.title.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.properties.urn.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Detalhes da permissão
Recupera informações detalhadas sobre uma permissão específica.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID da permissão para recuperar detalhes.
|
PermissionID | True | integer |
A ID da permissão para a qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Permissões GET. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.id.type | string | |
|
tipo
|
properties.longName.type | string | |
|
tipo
|
properties.shortName.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Detalhes da permissão do usuário
Recupera os detalhes de permissão para um usuário específico em um espaço de trabalho específico, com base na ID de permissão fornecida.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar detalhes.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Workspace List. |
|
Especifica a ID do usuário para recuperar detalhes.
|
UserID | True | string |
A ID do usuário para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Usuários GET. |
|
Especifica a ID da permissão para recuperar detalhes.
|
PermissionID | True | integer |
A ID da permissão para a qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Permissões GET. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.id.type | string | |
|
tipo
|
properties.longName.type | string | |
|
tipo
|
properties.shortName.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Detalhes da visualização do usuário
Recupera informações detalhadas sobre a exibição de um usuário específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para recuperar detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica a ID da Exibição do Usuário para recuperar detalhes.
|
ViewID | True | integer |
A ID da Visualização do Usuário para a qual você deseja recuperar detalhes pode ser obtida por meio da chamada de API de nível de acesso baseada em Visualizações de Usuário GET. |
|
Especifica o campo para classificar os resultados em ordem crescente.
|
asc | string |
Especifica o campo pelo qual os resultados devem ser classificados em ordem crescente. |
|
|
Especifica o campo para classificar os resultados em ordem decrescente.
|
desc | string |
Especifica o campo pelo qual os resultados devem ser classificados em ordem decrescente. |
|
|
Especifica o número de página dos resultados a serem recuperados.
|
page | string |
Especifica o número de página dos resultados a serem recuperados. Usado para paginar através de grandes conjuntos de dados. |
|
|
Especifica o número de itens a serem retornados por página em uma resposta paginada.
|
size | string |
Especifica o número de itens a serem retornados por página em uma resposta paginada. Isso permite que os clientes controlem o tamanho do conjunto de resultados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.columns.items.properties.displayName.type | string | |
|
tipo
|
properties.columns.items.properties.id.type | string | |
|
tipo
|
properties.columns.items.properties.index.type | string | |
|
required
|
properties.columns.items.required | array of string | |
|
tipo
|
properties.columns.items.type | string | |
|
tipo
|
properties.columns.type | string | |
|
items
|
properties.items | array of string | |
|
tipo
|
properties.pageNumber.type | string | |
|
tipo
|
properties.pageSize.type | string | |
|
tipo
|
properties.sortingColumns.items.properties.id.type | string | |
|
tipo
|
properties.sortingColumns.items.properties.index.type | string | |
|
tipo
|
properties.sortingColumns.items.properties.order.type | string | |
|
required
|
properties.sortingColumns.items.required | array of string | |
|
tipo
|
properties.sortingColumns.items.type | string | |
|
tipo
|
properties.sortingColumns.type | string | |
|
tipo
|
properties.total.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Detalhes do anexo
Recupera informações detalhadas sobre um anexo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do item para recuperar detalhes.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Workspace List. |
|
Especifica a ID do item para recuperar detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica a ID do anexo para recuperar detalhes.
|
AttachmentID | True | integer |
A ID do anexo para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Attachments List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.fileUrl.type | string | |
|
tipo
|
type | string |
Detalhes do campo do item
Exibe informações detalhadas sobre o campo especificado dentro de uma grade de itens.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do campo de grade para recuperação de detalhes.
|
FieldID | True | integer |
A ID do campo de grade para o qual você deseja recuperar detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.defaultValue.type | string | |
|
tipo
|
properties.description.type | string | |
|
tipo
|
properties.label.type | string | |
|
tipo
|
properties.type.properties.deleted.type | string | |
|
tipo
|
properties.type.properties.link.type | string | |
|
tipo
|
properties.type.properties.title.type | string | |
|
tipo
|
properties.type.properties.urn.type | string | |
|
tipo
|
properties.type.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Detalhes do item
Recupera informações detalhadas sobre um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para recuperar detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.audit.properties.deleted.type | string | |
|
tipo
|
properties.audit.properties.link.type | string | |
|
tipo
|
properties.audit.type | string | |
|
tipo
|
properties.bom.properties.deleted.type | string | |
|
tipo
|
properties.bom.properties.link.type | string | |
|
tipo
|
properties.bom.type | string | |
|
tipo
|
properties.currentState.properties.deleted.type | string | |
|
tipo
|
properties.currentState.properties.link.type | string | |
|
tipo
|
properties.currentState.properties.title.type | string | |
|
tipo
|
properties.currentState.properties.urn.type | string | |
|
tipo
|
properties.currentState.type | string | |
|
tipo
|
properties.deleted.type | string | |
|
tipo
|
properties.flatBom.properties.deleted.type | string | |
|
tipo
|
properties.flatBom.properties.link.type | string | |
|
tipo
|
properties.flatBom.type | string | |
|
tipo
|
properties.itemLocked.type | string | |
|
tipo
|
properties.latestRelease.type | string | |
|
tipo
|
properties.lifecycle.properties.deleted.type | string | |
|
tipo
|
properties.lifecycle.properties.link.type | string | |
|
tipo
|
properties.lifecycle.properties.title.type | string | |
|
tipo
|
properties.lifecycle.properties.urn.type | string | |
|
tipo
|
properties.lifecycle.type | string | |
|
tipo
|
properties.milestones.properties.deleted.type | string | |
|
tipo
|
properties.milestones.properties.link.type | string | |
|
tipo
|
properties.milestones.type | string | |
|
tipo
|
properties.nestedBom.properties.count.type | string | |
|
tipo
|
properties.nestedBom.properties.deleted.type | string | |
|
tipo
|
properties.nestedBom.properties.link.type | string | |
|
tipo
|
properties.nestedBom.type | string | |
|
tipo
|
properties.owners.properties.deleted.type | string | |
|
tipo
|
properties.owners.properties.link.type | string | |
|
tipo
|
properties.owners.type | string | |
|
tipo
|
properties.revertible.type | string | |
|
tipo
|
properties.root.properties.deleted.type | string | |
|
tipo
|
properties.root.properties.link.type | string | |
|
tipo
|
properties.root.properties.title.type | string | |
|
tipo
|
properties.root.properties.urn.type | string | |
|
tipo
|
properties.root.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.__self__.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.defaultValue.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.formulaField.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.isSystemField.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.title.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.type.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.urn.type | string | |
|
tipo
|
properties.sections.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.sections.items.properties.fields.items.required | array of string | |
|
tipo
|
properties.sections.items.properties.fields.items.type | string | |
|
tipo
|
properties.sections.items.properties.fields.type | string | |
|
tipo
|
properties.sections.items.properties.link.type | string | |
|
tipo
|
properties.sections.items.properties.sectionLocked.type | string | |
|
tipo
|
properties.sections.items.properties.title.type | string | |
|
required
|
properties.sections.items.required | array of string | |
|
tipo
|
properties.sections.items.type | string | |
|
tipo
|
properties.sections.type | string | |
|
tipo
|
properties.sectionsLink.type | string | |
|
tipo
|
properties.title.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
properties.whereUsed.properties.count.properties.type.type | string | |
|
tipo
|
properties.whereUsed.properties.count.properties.value.type | string | |
|
tipo
|
properties.whereUsed.properties.count.type | string | |
|
tipo
|
properties.whereUsed.properties.link.type | string | |
|
tipo
|
properties.whereUsed.type | string | |
|
tipo
|
properties.workflowReference.type | string | |
|
tipo
|
properties.workingHasChanged.type | string | |
|
tipo
|
properties.workingVersion.type | string | |
|
tipo
|
properties.workspace.properties.deleted.type | string | |
|
tipo
|
properties.workspace.properties.link.type | string | |
|
tipo
|
properties.workspace.properties.title.type | string | |
|
tipo
|
properties.workspace.properties.type.type | string | |
|
tipo
|
properties.workspace.properties.urn.type | string | |
|
tipo
|
properties.workspace.type | string | |
|
tipo
|
type | string |
Detalhes do Relatório
Recupera os detalhes completos de configuração do relatório.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do relatório para recuperar detalhes.
|
ReportID | True | integer |
A ID do relatório do qual você deseja recuperar detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.reportDefinition.properties.hasOrphanFields.type | string | |
|
tipo
|
properties.reportDefinition.properties.id.type | string | |
|
tipo
|
properties.reportDefinition.properties.isChartReport.type | string | |
|
tipo
|
properties.reportDefinition.properties.modifiedDate.type | string | |
|
tipo
|
properties.reportDefinition.properties.name.type | string | |
|
tipo
|
properties.reportDefinition.properties.owner.type | string | |
|
tipo
|
properties.reportDefinition.properties.workspaceId.type | string | |
|
tipo
|
properties.reportDefinition.type | string | |
|
tipo
|
properties.reportResult.properties.columnKey.items.properties.label.type | string | |
|
tipo
|
properties.reportResult.properties.columnKey.items.properties.value.type | string | |
|
required
|
properties.reportResult.properties.columnKey.items.required | array of string | |
|
tipo
|
properties.reportResult.properties.columnKey.items.type | string | |
|
tipo
|
properties.reportResult.properties.columnKey.type | string | |
|
tipo
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.dataType.type | string | |
|
tipo
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.label.type | string | |
|
tipo
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.properties.value.type | string | |
|
tipo
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.properties.fieldData.type | string | |
|
tipo
|
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 | |
|
tipo
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.items.type | string | |
|
tipo
|
properties.reportResult.properties.row.items.properties.fields.properties.entry.type | string | |
|
tipo
|
properties.reportResult.properties.row.items.properties.fields.type | string | |
|
tipo
|
properties.reportResult.properties.row.items.properties.rowId.type | string | |
|
required
|
properties.reportResult.properties.row.items.required | array of string | |
|
tipo
|
properties.reportResult.properties.row.items.type | string | |
|
tipo
|
properties.reportResult.properties.row.type | string | |
|
tipo
|
properties.reportResult.properties.totalResultCount.type | string | |
|
tipo
|
properties.reportResult.type | string | |
|
tipo
|
type | string |
Detalhes do script
Recupera o conteúdo e os detalhes de um script específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica o identificador exclusivo do script.
|
ScriptID | True | integer |
O identificador exclusivo do script a ser recuperado ou manipulado. Este é um parâmetro obrigatório e você deve fornecer um ScriptID válido como um inteiro no caminho da solicitação. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.code.type | string | |
|
dependeDe
|
properties.dependsOn | array of string | |
|
tipo
|
properties.displayName.type | string | |
|
tipo
|
properties.scriptType.type | string | |
|
tipo
|
properties.uniqueName.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
properties.version.type | string | |
|
tipo
|
type | string |
Detalhes do Utilizador
Recupera informações detalhadas sobre o usuário especificado. Se @me for usada, a API retornará detalhes sobre o usuário que está fazendo a chamada de API.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do usuário para recuperar detalhes.
|
UserID | True | string |
A ID do usuário para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Usuários GET. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
sobreMim
|
properties.aboutMe | object | |
|
tipo
|
properties.active.type | string | |
|
tipo
|
properties.address1.type | string | |
|
tipo
|
properties.address2.type | string | |
|
tipo
|
properties.alerts.items.properties.acknowledged.type | string | |
|
tipo
|
properties.alerts.items.properties.deleted.type | string | |
|
tipo
|
properties.alerts.items.properties.link.type | string | |
|
tipo
|
properties.alerts.items.properties.message.type | string | |
|
tipo
|
properties.alerts.items.properties.priority.type | string | |
|
tipo
|
properties.alerts.items.properties.title.type | string | |
|
tipo
|
properties.alerts.items.properties.type.type | string | |
|
tipo
|
properties.alerts.items.properties.urgent.type | string | |
|
tipo
|
properties.alerts.items.properties.urn.type | string | |
|
required
|
properties.alerts.items.required | array of string | |
|
tipo
|
properties.alerts.items.type | string | |
|
tipo
|
properties.alerts.type | string | |
|
tipo
|
properties.analyticsId.type | string | |
|
tipo
|
properties.batchNotifyPref.type | string | |
|
celular
|
properties.cellular | object | |
|
tipo
|
properties.city.type | string | |
|
tipo
|
properties.consumeLicense.type | string | |
|
tipo
|
properties.country.type | string | |
|
dashboardCharts
|
properties.dashboardCharts | object | |
|
tipo
|
properties.dateFormat.type | string | |
|
items
|
properties.delegations.items | string | |
|
tipo
|
properties.displayName.type | string | |
|
tipo
|
properties.displayNameExtended.type | string | |
|
tipo
|
properties.email.type | string | |
|
tipo
|
properties.enforce2fa.type | string | |
|
tipo
|
properties.entitlement.type | string | |
|
externalAuthReservationToken
|
properties.externalAuthReservationToken | object | |
|
tipo
|
properties.externalAuthUserId.type | string | |
|
Fax
|
properties.fax | object | |
|
tipo
|
properties.firstName.type | string | |
|
tipo
|
properties.groups.items.properties.link.type | string | |
|
tipo
|
properties.groups.items.properties.longName.type | string | |
|
tipo
|
properties.groups.items.properties.shortName.type | string | |
|
tipo
|
properties.groups.items.properties.urn.type | string | |
|
required
|
properties.groups.items.required | array of string | |
|
tipo
|
properties.groups.items.type | string | |
|
tipo
|
properties.groups.type | string | |
|
tipo
|
properties.id.type | string | |
|
tipo
|
properties.image.properties.large.type | string | |
|
tipo
|
properties.image.properties.medium.type | string | |
|
tipo
|
properties.image.properties.small.type | string | |
|
tipo
|
properties.image.type | string | |
|
indústria
|
properties.industry | object | |
|
tipo
|
properties.interfaceStyle.type | string | |
|
tipo
|
properties.interfaceStyleMandated.type | string | |
|
tipo
|
properties.lastAccessTime.type | string | |
|
tipo
|
properties.lastLicenseTimeIssued.type | string | |
|
tipo
|
properties.lastLoginTime.type | string | |
|
tipo
|
properties.lastMowUpdateDate.type | string | |
|
tipo
|
properties.lastName.type | string | |
|
tipo
|
properties.lastRecalculateStarted.type | string | |
|
tipo
|
properties.lastRecalculateUpdate.type | string | |
|
tipo
|
properties.ldapEnabled.type | string | |
|
licenseFeatureId
|
properties.licenseFeatureId | object | |
|
tipo
|
properties.licenseType.properties.deleted.type | string | |
|
tipo
|
properties.licenseType.properties.description.type | string | |
|
tipo
|
properties.licenseType.properties.link.type | string | |
|
tipo
|
properties.licenseType.properties.title.type | string | |
|
tipo
|
properties.licenseType.properties.type.type | string | |
|
tipo
|
properties.licenseType.properties.urn.type | string | |
|
tipo
|
properties.licenseType.type | string | |
|
tipo
|
properties.loginName.type | string | |
|
tipo
|
properties.mappedToOxygen.type | string | |
|
tipo
|
properties.organization.type | string | |
|
phone
|
properties.phone | object | |
|
tipo
|
properties.plmSearchCrawlerUser.type | string | |
|
tipo
|
properties.postal.type | string | |
|
tipo
|
properties.preferences.type | string | |
|
tipo
|
properties.regularUser.type | string | |
|
tipo
|
properties.reset.type | string | |
|
tipo
|
properties.showEnableFullAccess.type | string | |
|
inscriçãoUrl
|
properties.signupUrl | object | |
|
tipo
|
properties.stateProv.type | string | |
|
tipo
|
properties.surveyDone.type | string | |
|
tipo
|
properties.tenantAdmin.type | string | |
|
tipo
|
properties.thumbnailPref.type | string | |
|
tipo
|
properties.timezone.type | string | |
|
tipo
|
properties.title.type | string | |
|
tipo
|
properties.twoFaEnabled.type | string | |
|
tipo
|
properties.twoFactorAuthEnabled.type | string | |
|
tipo
|
properties.uomPref.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
properties.userActive.type | string | |
|
tipo
|
properties.userId.type | string | |
|
tipo
|
properties.userInactive.type | string | |
|
tipo
|
properties.userNumber.type | string | |
|
tipo
|
properties.userStatus.type | string | |
|
tipo
|
properties.wfNotifyPref.type | string | |
|
tipo
|
type | string |
Detalhes dos Grupos
Recupera informações detalhadas sobre um grupo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do grupo para recuperar detalhes.
|
GroupID | True | integer |
A ID do grupo para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Grupos GET. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.exclusiveGroup.type | string | |
|
tipo
|
properties.isSystemManaged.type | string | |
|
tipo
|
properties.mappedToOxygen.type | string | |
|
tipo
|
properties.minUserCount.type | string | |
|
tipo
|
properties.restrictIp.type | string | |
|
tipo
|
properties.shortName.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Download do relatório
Recupera informações detalhadas sobre um relatório/baixa o relatório
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar detalhes.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Workspace List. |
|
Especifica a ID do relatório a ser baixado.
|
ReportID | True | integer |
A ID do relatório que você deseja baixar. |
|
Especifica o número de página dos resultados a serem recuperados.
|
page | string |
Especifica o número de página dos resultados a serem recuperados. Usado para paginar através de grandes conjuntos de dados. |
|
|
Especifica o campo para classificar os resultados em ordem crescente.
|
asc | string |
Especifica o campo pelo qual os resultados devem ser classificados em ordem crescente. |
|
|
Especifica o campo para classificar os resultados em ordem decrescente.
|
desc | string |
Especifica o campo pelo qual os resultados devem ser classificados em ordem decrescente. |
|
|
Especifica o número de itens a serem retornados por página em uma resposta paginada.
|
size | string |
Especifica o número de itens a serem retornados por página em uma resposta paginada. Isso permite que os clientes controlem o tamanho do conjunto de resultados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.columns.items.properties.displayName.type | string | |
|
tipo
|
properties.columns.items.properties.id.type | string | |
|
tipo
|
properties.columns.items.properties.index.type | string | |
|
required
|
properties.columns.items.required | array of string | |
|
tipo
|
properties.columns.items.type | string | |
|
tipo
|
properties.columns.type | string | |
|
tipo
|
properties.items.items.properties.fields.items.properties.id.type | string | |
|
tipo
|
properties.items.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.items.items.properties.fields.items.required | array of string | |
|
tipo
|
properties.items.items.properties.fields.items.type | string | |
|
tipo
|
properties.items.items.properties.fields.type | string | |
|
tipo
|
properties.items.items.properties.index.type | string | |
|
tipo
|
properties.items.items.properties.item.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.item.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.item.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.item.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.pageNumber.type | string | |
|
tipo
|
properties.pageSize.type | string | |
|
tipo
|
properties.sortingColumns.items.properties.id.type | string | |
|
tipo
|
properties.sortingColumns.items.properties.index.type | string | |
|
tipo
|
properties.sortingColumns.items.properties.order.type | string | |
|
required
|
properties.sortingColumns.items.required | array of string | |
|
tipo
|
properties.sortingColumns.items.type | string | |
|
tipo
|
properties.sortingColumns.type | string | |
|
tipo
|
properties.total.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Excelente trabalho do usuário
Recupera o trabalho pendente para o usuário conectado por meio da API. O @me parâmetro é usado para se referir ao usuário conectado no momento, e não é possível escolher um usuário diferente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do usuário para recuperar detalhes.
|
UserID | True | string |
A ID do usuário para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Usuários GET. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.count.type | string | |
|
tipo
|
properties.lastRecalculateStarted.type | string | |
|
tipo
|
properties.lastRecalculateUpdate.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.delegated.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.escalated.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.item.properties.deleted.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.item.properties.link.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.item.properties.title.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.item.properties.urn.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.item.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.milestoneDate.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.milestoneStatus.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowStateName.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowStateSetDate.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.email.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.large.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.medium.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.image.properties.small.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.image.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.link.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.status.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.title.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.properties.urn.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workflowUser.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workspace.properties.deleted.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workspace.properties.link.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workspace.properties.title.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workspace.properties.type.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workspace.properties.urn.type | string | |
|
tipo
|
properties.outstandingWork.items.properties.workspace.type | string | |
|
required
|
properties.outstandingWork.items.required | array of string | |
|
tipo
|
properties.outstandingWork.items.type | string | |
|
tipo
|
properties.outstandingWork.type | string | |
|
tipo
|
properties.recalculating.type | string | |
|
tipo
|
type | string |
Item de Relacionamento Criar Item
Cria uma nova relação para um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para criar uma nova relação.
|
ItemID | True | integer |
A ID do item para o qual você cria um novo relacionamento (vinculá-lo a outro item) pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica o local de um item específico dentro de um espaço de trabalho.
|
content-location | string |
Especifica o local de um item específico dentro de um espaço de trabalho. O valor contém espaços reservados como :WorkspaceID e :ItemID, que precisam ser substituídos por IDs reais. |
|
|
pedido123
|
request123 |
Item onde usado
Recupera uma lista de onde o item específico é usado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item usado na lista técnica.
|
ItemID | True | integer |
A ID do item usado na lista técnica pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.config.properties.bias.type | string | |
|
tipo
|
properties.config.properties.bomViewDate.type | string | |
|
tipo
|
properties.config.properties.viewDef.properties.deleted.type | string | |
|
tipo
|
properties.config.properties.viewDef.properties.link.type | string | |
|
tipo
|
properties.config.properties.viewDef.properties.urn.type | string | |
|
tipo
|
properties.config.properties.viewDef.type | string | |
|
tipo
|
properties.config.type | string | |
|
tipo
|
properties.edges.items.properties.child.type | string | |
|
tipo
|
properties.edges.items.properties.depth.type | string | |
|
tipo
|
properties.edges.items.properties.edgeId.type | string | |
|
tipo
|
properties.edges.items.properties.edgeLink.type | string | |
|
campos
|
properties.edges.items.properties.fields | array of string | |
|
tipo
|
properties.edges.items.properties.itemNumber.type | string | |
|
tipo
|
properties.edges.items.properties.lastNode.type | string | |
|
tipo
|
properties.edges.items.properties.parent.type | string | |
|
required
|
properties.edges.items.required | array of string | |
|
tipo
|
properties.edges.items.type | string | |
|
tipo
|
properties.edges.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.nodes.items.properties.bomItems.type | string | |
|
tipo
|
properties.nodes.items.properties.bomRoot.type | string | |
|
tipo
|
properties.nodes.items.properties.fields.items.properties.isSystemField.type | string | |
|
tipo
|
properties.nodes.items.properties.fields.items.properties.title.type | string | |
|
tipo
|
properties.nodes.items.properties.fields.items.properties.value.type | string | |
|
required
|
properties.nodes.items.properties.fields.items.required | array of string | |
|
tipo
|
properties.nodes.items.properties.fields.items.type | string | |
|
tipo
|
properties.nodes.items.properties.fields.type | string | |
|
tipo
|
properties.nodes.items.properties.item.properties.deleted.type | string | |
|
tipo
|
properties.nodes.items.properties.item.properties.link.type | string | |
|
tipo
|
properties.nodes.items.properties.item.properties.title.type | string | |
|
tipo
|
properties.nodes.items.properties.item.properties.urn.type | string | |
|
tipo
|
properties.nodes.items.properties.item.properties.version.type | string | |
|
tipo
|
properties.nodes.items.properties.item.type | string | |
|
required
|
properties.nodes.items.required | array of string | |
|
tipo
|
properties.nodes.items.type | string | |
|
tipo
|
properties.nodes.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.root.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Item PrintView
Gera uma visualização de impressão de um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para criar um modo de exibição de impressão.
|
ItemID | True | integer |
A ID do item para o qual você cria um printview pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica a ID do Printview.
|
PrintViewID | True | string |
O ID do Printview, exemplo: 'APV-123' |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.hide.type | string | |
|
tipo
|
properties.printName.type | string | |
|
tipo
|
properties.urn.type | string | |
|
tipo
|
type | string |
Itens do espaço de trabalho
Recupera uma lista de todos os itens em um espaço de trabalho específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica o número máximo de itens a serem retornados na resposta.
|
limit | string |
Especifica o número máximo de itens a serem retornados na resposta. Isso é usado para limitar o tamanho do conjunto de resultados. |
|
|
Especifica o tipo de mídia esperado na resposta.
|
Accept | string |
Especifica o tipo de mídia que o cliente espera na resposta. Nesse caso, o cliente solicita que a resposta esteja no formato de dados de itens em massa no formato JSON. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.__self__.type | string | |
|
tipo
|
properties.items.items.properties.audit.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.audit.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.audit.type | string | |
|
tipo
|
properties.items.items.properties.bom.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.bom.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.bom.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.currentState.type | string | |
|
tipo
|
properties.items.items.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.flatBom.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.flatBom.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.flatBom.type | string | |
|
tipo
|
properties.items.items.properties.itemLocked.type | string | |
|
tipo
|
properties.items.items.properties.latestRelease.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.type | string | |
|
tipo
|
properties.items.items.properties.milestones.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.milestones.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.milestones.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.properties.count.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.type | string | |
|
tipo
|
properties.items.items.properties.owners.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.owners.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.owners.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.root.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type | string | |
|
tipo
|
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 | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.sectionLocked.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.title.type | string | |
|
required
|
properties.items.items.properties.sections.items.required | array of string | |
|
tipo
|
properties.items.items.properties.sections.items.type | string | |
|
tipo
|
properties.items.items.properties.sections.type | string | |
|
tipo
|
properties.items.items.properties.sectionsLink.type | string | |
|
tipo
|
properties.items.items.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.count.properties.type.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.count.properties.value.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.count.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.type | string | |
|
tipo
|
properties.items.items.properties.workflowReference.type | string | |
|
tipo
|
properties.items.items.properties.workingHasChanged.type | string | |
|
tipo
|
properties.items.items.properties.workingVersion.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.type.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.workspace.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.next.properties.count.type | string | |
|
tipo
|
properties.next.properties.deleted.type | string | |
|
tipo
|
properties.next.properties.link.type | string | |
|
tipo
|
properties.next.properties.title.type | string | |
|
tipo
|
properties.next.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Itens gerenciados por item
Recupera uma lista de itens gerenciados associados a um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar detalhes.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Workspace List. |
|
Especifica a ID do item para recuperar detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.affectedItems.items.properties.__self__.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.deleted.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.link.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.title.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.urn.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.title.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.uom.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.urn.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.value.type | string | |
|
required
|
properties.affectedItems.items.properties.linkedFields.items.required | array of string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.type | string | |
|
tipo
|
properties.affectedItems.items.properties.type.type | string | |
|
tipo
|
properties.affectedItems.items.properties.urn.type | string | |
|
required
|
properties.affectedItems.items.required | array of string | |
|
tipo
|
properties.affectedItems.items.type | string | |
|
tipo
|
properties.affectedItems.type | string | |
|
tipo
|
type | string |
Linhas da grade de itens
Recupera uma lista de linhas e campos para um item específico, incluindo seus valores.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para recuperar detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.aggregations.items.properties.__self__.type | string | |
|
tipo
|
properties.aggregations.items.properties.isSystemField.type | string | |
|
tipo
|
properties.aggregations.items.properties.title.type | string | |
|
tipo
|
properties.aggregations.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.aggregations.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.aggregations.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.aggregations.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.aggregations.items.properties.type.type | string | |
|
tipo
|
properties.aggregations.items.properties.urn.type | string | |
|
tipo
|
properties.aggregations.items.properties.value.type | string | |
|
required
|
properties.aggregations.items.required | array of string | |
|
tipo
|
properties.aggregations.items.type | string | |
|
tipo
|
properties.aggregations.type | string | |
|
propriedades
|
properties.rows.items.properties.metaFieldTableBean.properties.dataMap.properties | object | |
|
tipo
|
properties.rows.items.properties.metaFieldTableBean.properties.dataMap.type | string | |
|
tipo
|
properties.rows.items.properties.metaFieldTableBean.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.__self__.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.formulaField.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.isSystemField.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.title.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.type.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.urn.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.items.properties.value.type | string | |
|
required
|
properties.rows.items.properties.rowData.items.required | array of string | |
|
tipo
|
properties.rows.items.properties.rowData.items.type | string | |
|
tipo
|
properties.rows.items.properties.rowData.type | string | |
|
tipo
|
properties.rows.items.properties.rowID.type | string | |
|
required
|
properties.rows.items.required | array of string | |
|
tipo
|
properties.rows.items.type | string | |
|
tipo
|
properties.rows.type | string | |
|
tipo
|
type | string |
Lista de anexos
Recupera uma lista de todos os anexos de um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar detalhes.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Workspace List. |
|
Especifica a ID do item para recuperar detalhes.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica o campo para classificar os resultados em ordem crescente.
|
asc | string |
Especifica o campo pelo qual os resultados devem ser classificados em ordem crescente. Por exemplo, use 'nome' para classificar os resultados pelo campo de nome em ordem crescente. |
|
|
Especifica o tipo de mídia esperado na resposta.
|
Accept | string |
Especifica o tipo de mídia que o cliente espera na resposta. Nesse caso, o cliente solicita que a resposta esteja no formato de dados de anexo em massa no formato JSON. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.attachments.items.properties.created.properties.timeStamp.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.email.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.image.properties.large.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.image.properties.medium.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.image.properties.small.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.image.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.link.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.status.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.title.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.properties.urn.type | string | |
|
tipo
|
properties.attachments.items.properties.created.properties.user.type | string | |
|
tipo
|
properties.attachments.items.properties.created.type | string | |
|
tipo
|
properties.attachments.items.properties.description.type | string | |
|
tipo
|
properties.attachments.items.properties.folder.properties.id.type | string | |
|
tipo
|
properties.attachments.items.properties.folder.properties.name.type | string | |
|
tipo
|
properties.attachments.items.properties.folder.type | string | |
|
tipo
|
properties.attachments.items.properties.id.type | string | |
|
tipo
|
properties.attachments.items.properties.markups.properties.count.type | string | |
|
tipo
|
properties.attachments.items.properties.markups.properties.deleted.type | string | |
|
tipo
|
properties.attachments.items.properties.markups.properties.link.type | string | |
|
tipo
|
properties.attachments.items.properties.markups.type | string | |
|
tipo
|
properties.attachments.items.properties.name.type | string | |
|
tipo
|
properties.attachments.items.properties.resourceName.type | string | |
|
tipo
|
properties.attachments.items.properties.selfLink.type | string | |
|
tipo
|
properties.attachments.items.properties.size.type | string | |
|
tipo
|
properties.attachments.items.properties.status.properties.description.type | string | |
|
tipo
|
properties.attachments.items.properties.status.properties.label.type | string | |
|
tipo
|
properties.attachments.items.properties.status.properties.name.type | string | |
|
tipo
|
properties.attachments.items.properties.status.type | string | |
|
tipo
|
properties.attachments.items.properties.thumbnails.properties.large.type | string | |
|
tipo
|
properties.attachments.items.properties.thumbnails.properties.medium.type | string | |
|
tipo
|
properties.attachments.items.properties.thumbnails.properties.small.type | string | |
|
tipo
|
properties.attachments.items.properties.thumbnails.type | string | |
|
tipo
|
properties.attachments.items.properties.type.properties.extension.type | string | |
|
tipo
|
properties.attachments.items.properties.type.properties.fileType.type | string | |
|
tipo
|
properties.attachments.items.properties.type.properties.iconImage.type | string | |
|
tipo
|
properties.attachments.items.properties.type.properties.id.type | string | |
|
tipo
|
properties.attachments.items.properties.type.properties.viewable.type | string | |
|
tipo
|
properties.attachments.items.properties.type.type | string | |
|
tipo
|
properties.attachments.items.properties.url.type | string | |
|
tipo
|
properties.attachments.items.properties.urn.type | string | |
|
tipo
|
properties.attachments.items.properties.version.type | string | |
|
required
|
properties.attachments.items.required | array of string | |
|
tipo
|
properties.attachments.items.type | string | |
|
tipo
|
properties.attachments.type | string | |
|
tipo
|
properties.item.properties.deleted.type | string | |
|
tipo
|
properties.item.properties.link.type | string | |
|
tipo
|
properties.item.properties.title.type | string | |
|
tipo
|
properties.item.properties.urn.type | string | |
|
tipo
|
properties.item.type | string | |
|
tipo
|
type | string |
Lista de Campos de Detalhes do Item
Recupera uma lista de todos os campos disponíveis na guia Detalhes do Item.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperação de detalhes de campo.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar os detalhes do campo pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica o tipo de mídia esperado na resposta.
|
Accept | string |
Especifica o tipo de mídia que o cliente espera na resposta. Nesse caso, o cliente solicita que a resposta esteja no formato JSON. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.fields.items.properties.__self__.type | string | |
|
tipo
|
properties.fields.items.properties.defaultValue.type | string | |
|
tipo
|
properties.fields.items.properties.derived.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.__self__.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.title.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.link.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.title.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.type.properties.urn.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.type.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.properties.urn.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFieldSource.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.__self__.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.title.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.type.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.properties.urn.type | string | |
|
required
|
properties.fields.items.properties.derivedFields.items.required | array of string | |
|
tipo
|
properties.fields.items.properties.derivedFields.items.type | string | |
|
tipo
|
properties.fields.items.properties.derivedFields.type | string | |
|
tipo
|
properties.fields.items.properties.description.type | string | |
|
displayLength
|
properties.fields.items.properties.displayLength | object | |
|
tipo
|
properties.fields.items.properties.displayOrder.type | string | |
|
tipo
|
properties.fields.items.properties.editability.type | string | |
|
fieldLength
|
properties.fields.items.properties.fieldLength | object | |
|
fieldPrecision
|
properties.fields.items.properties.fieldPrecision | object | |
|
fieldValidadores
|
properties.fields.items.properties.fieldValidators | array of string | |
|
tipo
|
properties.fields.items.properties.formulaField.type | string | |
|
etiqueta
|
properties.fields.items.properties.label | object | |
|
tipo
|
properties.fields.items.properties.name.type | string | |
|
lista de opções
|
properties.fields.items.properties.picklist | object | |
|
picklistFieldDefinition
|
properties.fields.items.properties.picklistFieldDefinition | object | |
|
tipo
|
properties.fields.items.properties.pivotLink.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.fields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.fields.items.properties.type.type | string | |
|
unidadeDeMedida
|
properties.fields.items.properties.unitOfMeasure | object | |
|
tipo
|
properties.fields.items.properties.urn.type | string | |
|
validadores
|
properties.fields.items.properties.validators | object | |
|
tipo
|
properties.fields.items.properties.visibility.type | string | |
|
tipo
|
properties.fields.items.properties.visibleOnPreview.type | string | |
|
required
|
properties.fields.items.required | array of string | |
|
tipo
|
properties.fields.items.type | string | |
|
tipo
|
properties.fields.type | string | |
|
tipo
|
type | string |
Lista de espaços de trabalho
Recupera uma lista de todos os espaços de trabalho no locatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica o número máximo de itens a serem retornados na resposta.
|
limit | string |
Especifica o número máximo de itens a serem retornados na resposta. Isso é usado para limitar o tamanho do conjunto de resultados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.category.properties.displayOrder.type | string | |
|
tipo
|
properties.items.items.properties.category.properties.icon.type | string | |
|
tipo
|
properties.items.items.properties.category.properties.name.type | string | |
|
tipo
|
properties.items.items.properties.category.type | string | |
|
tipo
|
properties.items.items.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.displayOrder.type | string | |
|
tipo
|
properties.items.items.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.permissions.items.type | string | |
|
tipo
|
properties.items.items.properties.permissions.type | string | |
|
tipo
|
properties.items.items.properties.systemName.type | string | |
|
tipo
|
properties.items.items.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.urn.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Lista de exibição configurada para espaço de trabalho
Recupera uma lista de todos os modos de exibição configurados para um espaço de trabalho específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o modo de exibição configurado.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém a exibição configurada pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID de um item dentro do espaço de trabalho.
|
ItemID | True | integer |
A ID de um item dentro do espaço de trabalho pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
items.properties.deleted.type | string | |
|
tipo
|
items.properties.link.type | string | |
|
tipo
|
items.properties.title.type | string | |
|
tipo
|
items.properties.urn.type | string | |
|
required
|
items.required | array of string | |
|
tipo
|
items.type | string | |
|
tipo
|
type | string |
Lista de Grupos
Recupera uma lista de todos os grupos disponíveis no locatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica o índice para começar a recuperar itens de um conjunto de resultados paginado.
|
offset | string |
Especifica o ponto de partida ou índice do qual recuperar itens em um conjunto de resultados paginado. Útil para ignorar um determinado número de itens na lista. |
|
|
Especifica o número máximo de itens a serem retornados na resposta.
|
limit | string |
Especifica o número máximo de itens a serem retornados na resposta. Isso é usado para limitar o tamanho do conjunto de resultados. |
|
|
Classifica os resultados alfabeticamente em ordem crescente ou decrescente.
|
sort | string |
Classifica os resultados alfabeticamente em ordem crescente ou decrescente, dependendo do valor especificado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.groups.items.properties.__self__.type | string | |
|
tipo
|
properties.groups.items.properties.exclusiveGroup.type | string | |
|
tipo
|
properties.groups.items.properties.invariantName.type | string | |
|
tipo
|
properties.groups.items.properties.isSystemManaged.type | string | |
|
tipo
|
properties.groups.items.properties.longName.type | string | |
|
tipo
|
properties.groups.items.properties.mappedToOxygen.type | string | |
|
tipo
|
properties.groups.items.properties.minUserCount.type | string | |
|
tipo
|
properties.groups.items.properties.restrictIp.type | string | |
|
tipo
|
properties.groups.items.properties.shortName.type | string | |
|
tipo
|
properties.groups.items.properties.urn.type | string | |
|
required
|
properties.groups.items.required | array of string | |
|
tipo
|
properties.groups.items.type | string | |
|
tipo
|
properties.groups.type | string | |
|
tipo
|
type | string |
Lista de Itens Gerenciados
Recupera uma lista de itens gerenciados associados a um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item que contém a guia do item gerenciado.
|
ItemID | True | integer |
A ID do item que contém a guia do item gerenciado pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.affectedItems.items.properties.__self__.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.deleted.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.link.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.title.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.properties.urn.type | string | |
|
tipo
|
properties.affectedItems.items.properties.item.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.__self__.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.isSystemField.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.title.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.type.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.uom.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.uomConverted.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.urn.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.properties.value.type | string | |
|
required
|
properties.affectedItems.items.properties.linkedFields.items.required | array of string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.items.type | string | |
|
tipo
|
properties.affectedItems.items.properties.linkedFields.type | string | |
|
tipo
|
properties.affectedItems.items.properties.type.type | string | |
|
tipo
|
properties.affectedItems.items.properties.urn.type | string | |
|
required
|
properties.affectedItems.items.required | array of string | |
|
tipo
|
properties.affectedItems.items.type | string | |
|
tipo
|
properties.affectedItems.type | string | |
|
tipo
|
type | string |
Lista de permissões
Recupera uma lista de todas as permissões disponíveis no locatário.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.permissions.items.properties.deleted.type | string | |
|
tipo
|
properties.permissions.items.properties.link.type | string | |
|
tipo
|
properties.permissions.items.properties.name.type | string | |
|
tipo
|
properties.permissions.items.properties.title.type | string | |
|
tipo
|
properties.permissions.items.properties.urn.type | string | |
|
required
|
properties.permissions.items.required | array of string | |
|
tipo
|
properties.permissions.items.type | string | |
|
tipo
|
properties.permissions.type | string | |
|
tipo
|
type | string |
Lista de permissões do usuário
Recupera uma lista de todas as permissões atribuídas a um usuário específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do usuário para o qual recuperar detalhes.
|
UserID | True | string |
A ID do usuário para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Usuários GET. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.permissions.items.properties.deleted.type | string | |
|
tipo
|
properties.permissions.items.properties.link.type | string | |
|
tipo
|
properties.permissions.items.properties.name.type | string | |
|
tipo
|
properties.permissions.items.properties.title.type | string | |
|
tipo
|
properties.permissions.items.properties.urn.type | string | |
|
required
|
properties.permissions.items.required | array of string | |
|
tipo
|
properties.permissions.items.type | string | |
|
tipo
|
properties.permissions.type | string | |
|
tipo
|
type | string |
Lista de Relações de Item
Recupera uma lista de todos os itens de relacionamento associados a um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item que contém a guia relações.
|
ItemID | True | integer |
A ID do item que contém a guia relacionamentos pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
Lista de scripts
Recupera uma lista de todos os scripts dentro do locatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica o campo para ordenar os resultados.
|
orderBy | string |
Especifica o campo pelo qual os resultados devem ser ordenados. Por exemplo, usar 'scriptType' ordenará os resultados com base no tipo de script. Este parâmetro funciona em conjunto com 'asc' ou 'desc' para definir a direção de classificação. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.scripts.items.properties.__self__.type | string | |
|
tipo
|
properties.scripts.items.properties.dependsOn.items.properties.deleted.type | string | |
|
tipo
|
properties.scripts.items.properties.dependsOn.items.properties.link.type | string | |
|
tipo
|
properties.scripts.items.properties.dependsOn.items.properties.title.type | string | |
|
tipo
|
properties.scripts.items.properties.dependsOn.items.properties.urn.type | string | |
|
required
|
properties.scripts.items.properties.dependsOn.items.required | array of string | |
|
tipo
|
properties.scripts.items.properties.dependsOn.items.type | string | |
|
tipo
|
properties.scripts.items.properties.dependsOn.type | string | |
|
tipo
|
properties.scripts.items.properties.displayName.type | string | |
|
tipo
|
properties.scripts.items.properties.scriptType.type | string | |
|
tipo
|
properties.scripts.items.properties.uniqueName.type | string | |
|
tipo
|
properties.scripts.items.properties.urn.type | string | |
|
tipo
|
properties.scripts.items.properties.version.type | string | |
|
required
|
properties.scripts.items.required | array of string | |
|
tipo
|
properties.scripts.items.type | string | |
|
tipo
|
properties.scripts.type | string | |
|
tipo
|
type | string |
Lista de separadores de item de espaço de trabalho
Recupera uma lista de todas as guias configuradas para um espaço de trabalho específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para recuperar a lista de guias.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar uma lista de guias pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.tabs.items.properties.name.type | string | |
|
secçãoContagems
|
properties.tabs.items.properties.sectionCounts | object | |
|
tipo
|
properties.tabs.items.properties.totalCount.type | string | |
|
required
|
properties.tabs.items.required | array of string | |
|
tipo
|
properties.tabs.items.type | string | |
|
tipo
|
properties.tabs.type | string | |
|
tipo
|
type | string |
Lista de Seções de Item
Recupera uma lista de todas as seções na guia Detalhes do Item.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar seções de detalhes do item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar a configuração das seções de detalhes do item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
Devoluções
- Itens
- 200_sections
Lista de Utilizadores
Recupera uma lista de todos os usuários no locatário com a opção de filtrar por status.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Indica se apenas os usuários ativos devem ser exibidos.
|
activeOnly | string |
Se definido como true, mostra apenas os usuários que estão ativos no momento. |
|
|
mapeadoApenas
|
mappedOnly | string |
Se definido como true, mostra apenas os usuários mapeadosOnly |
|
|
Classifica os resultados alfabeticamente em ordem crescente ou decrescente.
|
sort | string |
Classifica os resultados alfabeticamente em ordem crescente ou decrescente, dependendo do valor especificado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.users.items.properties.deleted.type | string | |
|
tipo
|
properties.users.items.properties.link.type | string | |
|
tipo
|
properties.users.items.properties.title.type | string | |
|
tipo
|
properties.users.items.properties.urn.type | string | |
|
required
|
properties.users.items.required | array of string | |
|
tipo
|
properties.users.items.type | string | |
|
tipo
|
properties.users.type | string | |
|
tipo
|
type | string |
Lista PrintView do item
Recupera uma lista de modos de exibição de impressão disponíveis.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar a lista de modos de exibição de impressão.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja imprimir a lista de exibições pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Indica se os resultados devem ser classificados em ordem crescente.
|
asc | string |
Indica se os resultados devem ser classificados em ordem crescente. Use 'true' para ascendente ou deixe-o em branco para classificação padrão. |
|
|
Indica se os resultados devem ser classificados em ordem decrescente.
|
desc | string |
Indica se os resultados devem ser classificados em ordem decrescente. Use 'true' para decrescente ou deixe-o em branco para classificação padrão. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.links.items.properties.deleted.type | string | |
|
tipo
|
properties.links.items.properties.hidden.type | string | |
|
tipo
|
properties.links.items.properties.link.type | string | |
|
tipo
|
properties.links.items.properties.title.type | string | |
|
tipo
|
properties.links.items.properties.type.type | string | |
|
tipo
|
properties.links.items.properties.urn.type | string | |
|
required
|
properties.links.items.required | array of string | |
|
tipo
|
properties.links.items.type | string | |
|
tipo
|
properties.links.type | string | |
|
tipo
|
type | string |
Nível de acesso baseado em Visualizações do Usuário
Recupera uma lista de todas as exibições do usuário (filtro feito pelo usuário de itens dentro de um espaço de trabalho).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém as exibições do usuário.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém as exibições do usuário pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.links.items.properties.deleted.type | string | |
|
tipo
|
properties.links.items.properties.link.type | string | |
|
tipo
|
properties.links.items.properties.title.type | string | |
|
tipo
|
properties.links.items.properties.urn.type | string | |
|
required
|
properties.links.items.required | array of string | |
|
tipo
|
properties.links.items.type | string | |
|
tipo
|
properties.links.type | string | |
|
tipo
|
type | string |
Registo de Alterações de Itens
Recupera informações detalhadas sobre alterações feitas em um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para recuperar um log.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar um log pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.__self__.type | string | |
|
Nome longo
|
properties.items.items.properties.action.properties.longName | object | |
|
tipo
|
properties.items.items.properties.action.properties.notifyPermission.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.action.properties.notifyPermission.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.action.properties.notifyPermission.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.action.properties.notifyPermission.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.action.properties.notifyPermission.type | string | |
|
tipo
|
properties.items.items.properties.action.properties.shortName.type | string | |
|
tipo
|
properties.items.items.properties.action.type | string | |
|
tipo
|
properties.items.items.properties.actionInvoker.type | string | |
|
tipo
|
properties.items.items.properties.description.type | string | |
|
fieldName
|
properties.items.items.properties.details.items.properties.fieldName | object | |
|
tipo
|
properties.items.items.properties.details.items.properties.newValue.type | string | |
|
oldValue
|
properties.items.items.properties.details.items.properties.oldValue | object | |
|
tipo
|
properties.items.items.properties.details.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.details.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.details.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.details.items.properties.type.type | string | |
|
required
|
properties.items.items.properties.details.items.required | array of string | |
|
tipo
|
properties.items.items.properties.details.items.type | string | |
|
tipo
|
properties.items.items.properties.details.type | string | |
|
tipo
|
properties.items.items.properties.timeStamp.type | string | |
|
tipo
|
properties.items.items.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.email.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.large.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.medium.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.small.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.status.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.user.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.next.properties.count.type | string | |
|
tipo
|
properties.next.properties.deleted.type | string | |
|
tipo
|
properties.next.properties.link.type | string | |
|
tipo
|
properties.next.properties.title.type | string | |
|
tipo
|
properties.next.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Registo de Itens
Recupera informações detalhadas de log para um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para o qual recuperar um log.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar um log pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica o índice inicial para recuperar itens em um conjunto de resultados paginado.
|
offset | string |
Especifica o ponto de partida ou índice do qual recuperar itens em um conjunto de resultados paginado. Útil para ignorar um determinado número de itens na lista. |
|
|
Especifica o número máximo de itens a serem retornados na resposta.
|
limit | string |
Especifica o número máximo de itens a serem retornados na resposta. Isso é usado para limitar o tamanho do conjunto de resultados. |
|
|
Especifica o campo para classificar os resultados em ordem crescente.
|
asc | string |
Especifica o campo pelo qual os resultados devem ser classificados em ordem crescente. Por exemplo, usar 'timeStamp' classificará os resultados com base na hora em que foram criados ou modificados. |
|
|
Especifica o campo para classificar os resultados em ordem decrescente.
|
desc | string |
Especifica o campo pelo qual os resultados devem ser classificados em ordem decrescente. Por exemplo, usar 'timeStamp' classificará os resultados com base na hora em que foram criados ou modificados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.__self__.type | string | |
|
Nome longo
|
properties.items.items.properties.action.properties.longName | object | |
|
notificarPermissão
|
properties.items.items.properties.action.properties.notifyPermission | object | |
|
tipo
|
properties.items.items.properties.action.properties.shortName.type | string | |
|
tipo
|
properties.items.items.properties.action.type | string | |
|
tipo
|
properties.items.items.properties.actionInvoker.type | string | |
|
tipo
|
properties.items.items.properties.description.type | string | |
|
tipo
|
properties.items.items.properties.details.type | string | |
|
tipo
|
properties.items.items.properties.timeStamp.type | string | |
|
tipo
|
properties.items.items.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.email.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.large.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.medium.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.small.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.status.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.user.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.next.properties.count.type | string | |
|
tipo
|
properties.next.properties.deleted.type | string | |
|
tipo
|
properties.next.properties.link.type | string | |
|
tipo
|
properties.next.properties.title.type | string | |
|
tipo
|
properties.next.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Relação do item Detalhe do item V1
Recupera uma lista de relações para um item específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Indica a ID do espaço de trabalho que contém os itens.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém os itens pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Indica a ID do item para recuperar detalhes de relacionamento.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar detalhes de relacionamento pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica o número da página para recuperação de resultados.
|
page | string |
Especifica o número de página dos resultados a serem recuperados. Usado para paginar através de grandes conjuntos de dados. |
|
|
Especifica o número de itens por página em uma resposta paginada.
|
size | string |
Especifica o número de itens a serem retornados por página em uma resposta paginada. Isso permite que os clientes controlem o tamanho do conjunto de resultados. |
|
|
Especifica o campo usado para classificar os resultados.
|
sort | string |
Especifica o campo pelo qual os resultados devem ser classificados. Exemplo: 'createdOn' para classificação por data de criação. |
|
|
Especifica a direção de classificação dos resultados.
|
sortDirection | string |
Especifica a direção de classificação. Use 'ASC' para ascendente e 'DESC' para descendente. Exemplo: 'ASC' para ordenar por ordem crescente. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.list.properties.item-relationship.items.properties.description.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.direction.properties.label.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.direction.properties.value.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.direction.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.description.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.deleted.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.dmsID.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.latest.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.effectivity.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateID.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.properties.stateName.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.lifecycleState.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.timeStamp.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.version.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.versionID.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateId.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.properties.stateName.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workflowState.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.working.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.properties.workspaceID.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.details.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.id.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.dataType.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.properties.value.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.properties.fieldData.type | string | |
|
tipo
|
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 | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.items.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.metaFields.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.properties.uri.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.item.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.type.properties.label.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.type.properties.value.type | string | |
|
tipo
|
properties.list.properties.item-relationship.items.properties.type.type | string | |
|
required
|
properties.list.properties.item-relationship.items.required | array of string | |
|
tipo
|
properties.list.properties.item-relationship.items.type | string | |
|
tipo
|
properties.list.properties.item-relationship.type | string | |
|
tipo
|
properties.list.type | string | |
|
tipo
|
type | string |
Script Criar Novo
Cria um novo script do tipo especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | True | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
pedido123
|
request123 |
Tipos de campo de item
Fornece uma lista de todos os tipos de campo disponíveis.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.field-types.items.properties.deleted.type | string | |
|
tipo
|
properties.field-types.items.properties.link.type | string | |
|
tipo
|
properties.field-types.items.properties.title.type | string | |
|
tipo
|
properties.field-types.items.properties.urn.type | string | |
|
required
|
properties.field-types.items.required | array of string | |
|
tipo
|
properties.field-types.items.type | string | |
|
tipo
|
properties.field-types.type | string | |
|
tipo
|
type | string |
Transição de itens
Executa uma transição em um item específico. Retorna 403 mesmo quando bem-sucedido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para executar uma transição.
|
ItemID | True | integer |
A ID do item no qual você deseja executar uma transição pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica a ID da transição de fluxo de trabalho a ser executada.
|
WorkflowID | True | integer |
A ID da transição de fluxo de trabalho que você deseja executar. |
|
Especifica o local do recurso ou conteúdo.
|
content-location | True | string |
Especifica o local do recurso ou conteúdo. Este deve ser um URL ou caminho válido para onde o conteúdo está hospedado ou recuperado. |
|
pedido123
|
request123 |
Transições de lista de espaços de trabalho
Recupera uma lista de transições disponíveis para um espaço de trabalho específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar a lista de transição.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar uma lista de transição pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID de um item dentro do espaço de trabalho.
|
ItemID | True | integer |
A ID de um item dentro do espaço de trabalho pode ser obtida por meio da chamada da API GET Item List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
items.properties.__self__.type | string | |
|
tipo
|
items.properties.actionScript.properties.deleted.type | string | |
|
tipo
|
items.properties.actionScript.properties.link.type | string | |
|
tipo
|
items.properties.actionScript.properties.title.type | string | |
|
tipo
|
items.properties.actionScript.properties.urn.type | string | |
|
tipo
|
items.properties.actionScript.type | string | |
|
tipo
|
items.properties.approvers.type | string | |
|
tipo
|
items.properties.comments.type | string | |
|
tipo
|
items.properties.customLabel.type | string | |
|
tipo
|
items.properties.delegatorUsers.type | string | |
|
tipo
|
items.properties.escalationPermission.properties.deleted.type | string | |
|
tipo
|
items.properties.escalationPermission.properties.link.type | string | |
|
tipo
|
items.properties.escalationPermission.properties.title.type | string | |
|
tipo
|
items.properties.escalationPermission.properties.urn.type | string | |
|
tipo
|
items.properties.escalationPermission.type | string | |
|
tipo
|
items.properties.fromState.properties.deleted.type | string | |
|
tipo
|
items.properties.fromState.properties.link.type | string | |
|
tipo
|
items.properties.fromState.properties.title.type | string | |
|
tipo
|
items.properties.fromState.properties.urn.type | string | |
|
tipo
|
items.properties.fromState.type | string | |
|
tipo
|
items.properties.hidden.type | string | |
|
tipo
|
items.properties.ignoreEscalatedPreconditions.type | string | |
|
tipo
|
items.properties.labelPositionA.type | string | |
|
tipo
|
items.properties.labelPositionB.type | string | |
|
tipo
|
items.properties.name.type | string | |
|
tipo
|
items.properties.notifyPerformers.type | string | |
|
tipo
|
items.properties.passwordEnabled.type | string | |
|
tipo
|
items.properties.permission.properties.deleted.type | string | |
|
tipo
|
items.properties.permission.properties.link.type | string | |
|
tipo
|
items.properties.permission.properties.title.type | string | |
|
tipo
|
items.properties.permission.properties.urn.type | string | |
|
tipo
|
items.properties.permission.type | string | |
|
pontos
|
items.properties.points | object | |
|
tipo
|
items.properties.sendEmail.type | string | |
|
tipo
|
items.properties.showInOutstanding.type | string | |
|
tipo
|
items.properties.toState.properties.deleted.type | string | |
|
tipo
|
items.properties.toState.properties.link.type | string | |
|
tipo
|
items.properties.toState.properties.title.type | string | |
|
tipo
|
items.properties.toState.properties.urn.type | string | |
|
tipo
|
items.properties.toState.type | string | |
|
tipo
|
items.properties.urn.type | string | |
|
tipo
|
items.properties.workspace.properties.deleted.type | string | |
|
tipo
|
items.properties.workspace.properties.link.type | string | |
|
tipo
|
items.properties.workspace.properties.title.type | string | |
|
tipo
|
items.properties.workspace.properties.type.type | string | |
|
tipo
|
items.properties.workspace.properties.urn.type | string | |
|
tipo
|
items.properties.workspace.type | string | |
|
required
|
items.required | array of string | |
|
tipo
|
items.type | string | |
|
tipo
|
type | string |
Transições disponíveis
Recupera uma lista de transições disponíveis para um item específico com base no usuário conectado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho para recuperar transições disponíveis.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho para o qual você deseja recuperar uma lista de transições disponíveis pode ser obtida por meio da chamada da API GET Workspace List. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
items.properties.__self__.type | string | |
|
tipo
|
items.properties.actionScript.properties.deleted.type | string | |
|
tipo
|
items.properties.actionScript.properties.link.type | string | |
|
tipo
|
items.properties.actionScript.properties.title.type | string | |
|
tipo
|
items.properties.actionScript.properties.urn.type | string | |
|
tipo
|
items.properties.actionScript.type | string | |
|
aprovadores
|
items.properties.approvers | array of string | |
|
tipo
|
items.properties.comments.type | string | |
|
tipo
|
items.properties.conditionScript.properties.deleted.type | string | |
|
tipo
|
items.properties.conditionScript.properties.link.type | string | |
|
tipo
|
items.properties.conditionScript.properties.title.type | string | |
|
tipo
|
items.properties.conditionScript.properties.urn.type | string | |
|
tipo
|
items.properties.conditionScript.type | string | |
|
tipo
|
items.properties.customLabel.type | string | |
|
deleganteUtilizadores
|
items.properties.delegatorUsers | array of string | |
|
tipo
|
items.properties.escalationPermission.properties.deleted.type | string | |
|
tipo
|
items.properties.escalationPermission.properties.link.type | string | |
|
tipo
|
items.properties.escalationPermission.properties.title.type | string | |
|
tipo
|
items.properties.escalationPermission.properties.urn.type | string | |
|
tipo
|
items.properties.escalationPermission.type | string | |
|
tipo
|
items.properties.fromState.properties.deleted.type | string | |
|
tipo
|
items.properties.fromState.properties.link.type | string | |
|
tipo
|
items.properties.fromState.properties.title.type | string | |
|
tipo
|
items.properties.fromState.properties.urn.type | string | |
|
tipo
|
items.properties.fromState.type | string | |
|
tipo
|
items.properties.hidden.type | string | |
|
tipo
|
items.properties.ignoreEscalatedPreconditions.type | string | |
|
tipo
|
items.properties.labelPositionA.type | string | |
|
tipo
|
items.properties.labelPositionB.type | string | |
|
tipo
|
items.properties.name.type | string | |
|
tipo
|
items.properties.notifyPerformers.type | string | |
|
tipo
|
items.properties.passwordEnabled.type | string | |
|
tipo
|
items.properties.permission.properties.deleted.type | string | |
|
tipo
|
items.properties.permission.properties.link.type | string | |
|
tipo
|
items.properties.permission.properties.title.type | string | |
|
tipo
|
items.properties.permission.properties.urn.type | string | |
|
tipo
|
items.properties.permission.type | string | |
|
pontos
|
items.properties.points | object | |
|
tipo
|
items.properties.sendEmail.type | string | |
|
tipo
|
items.properties.showInOutstanding.type | string | |
|
tipo
|
items.properties.toState.properties.deleted.type | string | |
|
tipo
|
items.properties.toState.properties.link.type | string | |
|
tipo
|
items.properties.toState.properties.title.type | string | |
|
tipo
|
items.properties.toState.properties.urn.type | string | |
|
tipo
|
items.properties.toState.type | string | |
|
tipo
|
items.properties.urn.type | string | |
|
tipo
|
items.properties.validationScript.properties.deleted.type | string | |
|
tipo
|
items.properties.validationScript.properties.link.type | string | |
|
tipo
|
items.properties.validationScript.properties.title.type | string | |
|
tipo
|
items.properties.validationScript.properties.urn.type | string | |
|
tipo
|
items.properties.validationScript.type | string | |
|
tipo
|
items.properties.workspace.properties.deleted.type | string | |
|
tipo
|
items.properties.workspace.properties.link.type | string | |
|
tipo
|
items.properties.workspace.properties.title.type | string | |
|
tipo
|
items.properties.workspace.properties.type.type | string | |
|
tipo
|
items.properties.workspace.properties.urn.type | string | |
|
tipo
|
items.properties.workspace.type | string | |
|
required
|
items.required | array of string | |
|
tipo
|
items.type | string | |
|
tipo
|
type | string |
Usuários em grupo
Recupera uma lista de usuários e seus detalhes para um grupo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do grupo para o qual recuperar detalhes.
|
GroupID | True | integer |
A ID do grupo para o qual você deseja recuperar detalhes pode ser obtida por meio da chamada da API da Lista de Grupos GET. |
|
Especifica o índice inicial para recuperar itens em um conjunto de resultados paginado.
|
offset | string |
Especifica o ponto de partida ou índice do qual recuperar itens em um conjunto de resultados paginado. Útil para ignorar um determinado número de itens na lista. |
|
|
Especifica o número máximo de itens a serem retornados na resposta.
|
limit | string |
Especifica o número máximo de itens a serem retornados na resposta. Isso é usado para limitar o tamanho do conjunto de resultados. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.__self__.type | string | |
|
sobreMim
|
properties.items.items.properties.aboutMe | object | |
|
tipo
|
properties.items.items.properties.active.type | string | |
|
tipo
|
properties.items.items.properties.address1.type | string | |
|
tipo
|
properties.items.items.properties.address2.type | string | |
|
tipo
|
properties.items.items.properties.analyticsId.type | string | |
|
tipo
|
properties.items.items.properties.batchNotifyPref.type | string | |
|
tipo
|
properties.items.items.properties.cellular.type | string | |
|
tipo
|
properties.items.items.properties.city.type | string | |
|
tipo
|
properties.items.items.properties.consumeLicense.type | string | |
|
tipo
|
properties.items.items.properties.country.type | string | |
|
dashboardCharts
|
properties.items.items.properties.dashboardCharts | object | |
|
tipo
|
properties.items.items.properties.dateFormat.type | string | |
|
delegações
|
properties.items.items.properties.delegations | array of string | |
|
tipo
|
properties.items.items.properties.displayName.type | string | |
|
tipo
|
properties.items.items.properties.displayNameExtended.type | string | |
|
tipo
|
properties.items.items.properties.email.type | string | |
|
tipo
|
properties.items.items.properties.enforce2fa.type | string | |
|
tipo
|
properties.items.items.properties.entitlement.type | string | |
|
externalAuthReservationToken
|
properties.items.items.properties.externalAuthReservationToken | object | |
|
tipo
|
properties.items.items.properties.externalAuthUserId.type | string | |
|
tipo
|
properties.items.items.properties.fax.type | string | |
|
tipo
|
properties.items.items.properties.firstName.type | string | |
|
tipo
|
properties.items.items.properties.id.type | string | |
|
indústria
|
properties.items.items.properties.industry | object | |
|
tipo
|
properties.items.items.properties.interfaceStyle.type | string | |
|
tipo
|
properties.items.items.properties.interfaceStyleMandated.type | string | |
|
tipo
|
properties.items.items.properties.lastAccessTime.type | string | |
|
tipo
|
properties.items.items.properties.lastLicenseTimeIssued.type | string | |
|
tipo
|
properties.items.items.properties.lastLoginTime.type | string | |
|
tipo
|
properties.items.items.properties.lastMowUpdateDate.type | string | |
|
tipo
|
properties.items.items.properties.lastName.type | string | |
|
tipo
|
properties.items.items.properties.lastRecalculateStarted.type | string | |
|
tipo
|
properties.items.items.properties.lastRecalculateUpdate.type | string | |
|
tipo
|
properties.items.items.properties.ldapEnabled.type | string | |
|
tipo
|
properties.items.items.properties.licenseFeatureId.type | string | |
|
tipo
|
properties.items.items.properties.licenseType.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.licenseType.properties.description.type | string | |
|
tipo
|
properties.items.items.properties.licenseType.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.licenseType.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.licenseType.properties.type.type | string | |
|
tipo
|
properties.items.items.properties.licenseType.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.licenseType.type | string | |
|
tipo
|
properties.items.items.properties.loginName.type | string | |
|
tipo
|
properties.items.items.properties.mappedToOxygen.type | string | |
|
tipo
|
properties.items.items.properties.organization.type | string | |
|
tipo
|
properties.items.items.properties.phone.type | string | |
|
tipo
|
properties.items.items.properties.plmSearchCrawlerUser.type | string | |
|
tipo
|
properties.items.items.properties.postal.type | string | |
|
tipo
|
properties.items.items.properties.regularUser.type | string | |
|
tipo
|
properties.items.items.properties.reset.type | string | |
|
inscriçãoUrl
|
properties.items.items.properties.signupUrl | object | |
|
tipo
|
properties.items.items.properties.stateProv.type | string | |
|
inquéritoConcluído
|
properties.items.items.properties.surveyDone | object | |
|
tipo
|
properties.items.items.properties.tenantAdmin.type | string | |
|
tipo
|
properties.items.items.properties.thumbnailPref.type | string | |
|
tipo
|
properties.items.items.properties.timezone.type | string | |
|
tipo
|
properties.items.items.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.twoFactorAuthEnabled.type | string | |
|
tipo
|
properties.items.items.properties.uomPref.type | string | |
|
tipo
|
properties.items.items.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.userActive.type | string | |
|
tipo
|
properties.items.items.properties.userId.type | string | |
|
tipo
|
properties.items.items.properties.userInactive.type | string | |
|
tipo
|
properties.items.items.properties.userNumber.type | string | |
|
tipo
|
properties.items.items.properties.userStatus.type | string | |
|
tipo
|
properties.items.items.properties.wfNotifyPref.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Valor de pesquisa em todo o locatário
Procura um valor em todos os itens em todo o locatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica o termo de pesquisa para consultar dados de locatário.
|
query | string |
O termo de pesquisa a ser usado para consultar os dados do locatário. |
|
|
Especifica o número máximo de itens a serem retornados na resposta.
|
limit | string |
Especifica o número máximo de itens a serem retornados na resposta. Isso é usado para limitar o tamanho do conjunto de resultados. |
|
|
Especifica a ordem de classificação dos resultados.
|
sort | string |
Especifica a ordem de classificação dos resultados. Use 'asc' para ascendente e 'desc' para descendente. Exemplo: 'createdOn asc' para classificação por data de criação em ordem crescente. |
|
|
Especifica o tipo de mídia esperado na resposta.
|
Accept | string |
Especifica o tipo de mídia que o cliente espera na resposta. Nesse caso, o cliente solicita que a resposta esteja no formato de dados de itens em massa no formato JSON. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.__self__.type | string | |
|
tipo
|
properties.items.items.properties.audit.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.audit.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.audit.type | string | |
|
tipo
|
properties.items.items.properties.bom.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.bom.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.bom.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.currentState.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.currentState.type | string | |
|
tipo
|
properties.items.items.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.flatBom.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.flatBom.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.flatBom.type | string | |
|
tipo
|
properties.items.items.properties.itemLocked.type | string | |
|
tipo
|
properties.items.items.properties.latestRelease.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.lifecycle.type | string | |
|
tipo
|
properties.items.items.properties.milestones.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.milestones.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.milestones.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.properties.count.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.nestedBom.type | string | |
|
tipo
|
properties.items.items.properties.owners.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.owners.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.owners.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.root.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.root.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.__self__.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.defaultValue.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.formulaField.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.isSystemField.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.type.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.properties.urn.type | string | |
|
tipo
|
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 | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.items.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.fields.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.sectionLocked.type | string | |
|
tipo
|
properties.items.items.properties.sections.items.properties.title.type | string | |
|
required
|
properties.items.items.properties.sections.items.required | array of string | |
|
tipo
|
properties.items.items.properties.sections.items.type | string | |
|
tipo
|
properties.items.items.properties.sections.type | string | |
|
tipo
|
properties.items.items.properties.sectionsLink.type | string | |
|
tipo
|
properties.items.items.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.count.properties.type.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.count.properties.value.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.count.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.whereUsed.type | string | |
|
tipo
|
properties.items.items.properties.workflowReference.type | string | |
|
tipo
|
properties.items.items.properties.workingHasChanged.type | string | |
|
tipo
|
properties.items.items.properties.workingVersion.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.deleted.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.type.type | string | |
|
tipo
|
properties.items.items.properties.workspace.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.workspace.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Versão de criação de anexo
Cria uma nova versão de um anexo existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item que contém o anexo.
|
ItemID | True | integer |
A ID do item que contém o anexo pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica a ID do anexo para criar uma nova versão.
|
AttachmentID | True | integer |
A ID do anexo para o qual você deseja criar uma nova versão pode ser obtida por meio da chamada da API GET Attachments List. |
|
Indica o tipo de mídia do corpo da solicitação.
|
Content-Type | string |
Indica o tipo de mídia do corpo da solicitação. Nesse caso, espera-se que o corpo da solicitação esteja no formato JSON. |
|
|
pedido123
|
request123 |
Visão geral da guia Itens
Recupera uma lista de registros e campos para uma guia específica.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Especifica a ID do espaço de trabalho que contém o item.
|
WorkspaceID | True | integer |
A ID do espaço de trabalho que contém o item pode ser obtida por meio da chamada da API da Lista de Espaços de Trabalho GET. |
|
Especifica a ID do item para recuperar registros e campos para uma guia/exibição.
|
ItemID | True | integer |
A ID do item para o qual você deseja recuperar uma lista de registros e campos para uma guia/exibição específica pode ser obtida por meio da chamada da API GET Item List. |
|
Especifica o ID da guia/exibição para recuperação de detalhes.
|
ViewID | True | integer |
A ID da guia/exibição para a qual você deseja recuperar detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
properties.__self__.type | string | |
|
tipo
|
properties.first.properties.count.type | string | |
|
tipo
|
properties.first.properties.deleted.type | string | |
|
tipo
|
properties.first.properties.link.type | string | |
|
tipo
|
properties.first.properties.title.type | string | |
|
tipo
|
properties.first.type | string | |
|
tipo
|
properties.items.items.properties.__self__.type | string | |
|
Nome longo
|
properties.items.items.properties.action.properties.longName | object | |
|
notificarPermissão
|
properties.items.items.properties.action.properties.notifyPermission | object | |
|
tipo
|
properties.items.items.properties.action.properties.shortName.type | string | |
|
tipo
|
properties.items.items.properties.action.type | string | |
|
tipo
|
properties.items.items.properties.actionInvoker.type | string | |
|
tipo
|
properties.items.items.properties.description.type | string | |
|
tipo
|
properties.items.items.properties.details.type | string | |
|
tipo
|
properties.items.items.properties.timeStamp.type | string | |
|
tipo
|
properties.items.items.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.email.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.large.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.medium.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.properties.small.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.image.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.link.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.status.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.title.type | string | |
|
tipo
|
properties.items.items.properties.user.properties.urn.type | string | |
|
tipo
|
properties.items.items.properties.user.type | string | |
|
required
|
properties.items.items.required | array of string | |
|
tipo
|
properties.items.items.type | string | |
|
tipo
|
properties.items.type | string | |
|
tipo
|
properties.last.properties.count.type | string | |
|
tipo
|
properties.last.properties.deleted.type | string | |
|
tipo
|
properties.last.properties.link.type | string | |
|
tipo
|
properties.last.properties.title.type | string | |
|
tipo
|
properties.last.type | string | |
|
tipo
|
properties.limit.type | string | |
|
tipo
|
properties.offset.type | string | |
|
tipo
|
properties.totalCount.type | string | |
|
tipo
|
type | string |
Definições
200_sections
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string | |
|
descrição
|
description | string | |
|
tipo
|
type | string | |
|
displayEncomendar
|
displayOrder | integer | |
|
sectionType
|
sectionType | string | |
|
campos
|
fields | array of object | |
|
ligação
|
fields.link | string | |
|
urna
|
fields.urn | string | |
|
title
|
fields.title | string | |
|
Suprimido
|
fields.deleted | boolean | |
|
tipo
|
fields.type | string | |
|
seçãoBloqueado
|
sectionLocked | boolean | |
|
pimSecção
|
pimSection | boolean | |
|
__self__
|
__self__ | string | |
|
urna
|
urn | string | |
|
Matrizes
|
matrices | array of object | |
|
__self__
|
matrices.__self__ | string | |
|
urna
|
matrices.urn | string | |
|
Largura
|
matrices.width | integer | |
|
altura
|
matrices.height | integer | |
|
columnNames
|
matrices.columnNames | array of string | |
|
rowNomes
|
matrices.rowNames | array of string | |
|
campos
|
matrices.fields | array of array | |
|
items
|
matrices.fields | array of object | |
|
ligação
|
matrices.fields.link | string | |
|
urna
|
matrices.fields.urn | string | |
|
title
|
matrices.fields.title | string | |
|
Suprimido
|
matrices.fields.deleted | boolean | |
|
tipo
|
matrices.fields.type | string |
ApiV3Workspaces-WorkspaceID-Items-ItemID-Views10Get200ApplicationJsonResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
string |