Programas Sísmicos (Pré-visualização)
O conector do Programa Sísmico oferece uma coleção de ações e gatilhos projetados para interagir com os principais recursos do produto Programas Sísmicos. Estes incluem programas, que acompanham o progresso e as configurações do seu programa de capacitação em curso; tarefas, a ferramenta de gestão do trabalho que monitoriza as atividades da sua equipa; e solicitações, que permitem que membros externos da equipe enviem solicitações de trabalho para sua equipe.
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 | Sísmica |
| URL | https://seismic.com |
| support@seismic.com |
| Metadados do conector | |
|---|---|
| Editora | Software sísmico |
| Sítio Web | https://seismic.com/ |
| Política de privacidade | https://seismic.com/privacy-policy/ |
| Categorias | Marketing; Vendas e CRM |
Conector do programa sísmico
O conector do Programa Sísmico oferece uma coleção de ações e gatilhos projetados para interagir com os principais recursos do produto Programas Sísmicos. Estes incluem programas, que acompanham o progresso e as configurações do seu programa de capacitação em curso; tarefas, a ferramenta de gestão do trabalho que monitoriza as atividades da sua equipa; e solicitações, que permitem que membros externos da equipe enviem solicitações de trabalho para sua equipe.
Editora: Sísmica
Pré-requisitos
Você precisa de uma conta de usuário Seismic Premium para o locatário.
Operações suportadas
Receba comentários
Obtenha uma lista de comentários em um único nó (programa, tarefa, solicitação).
Receba um comentário
Obtenha um único comentário sobre um único nó (programa, tarefa, solicitação).
Criar um comentário
Crie um comentário em um único nó (programa, tarefa, solicitação).
Atualizar um comentário
Atualize um comentário existente em um único nó (programa, tarefa, solicitação).
Excluir um comentário
Exclua um comentário em um único nó (programa, tarefa, solicitação).
Obter programas
Obtenha uma lista de programas em um locatário.
Obter um programa
Obtenha um único programa em um locatário.
Criar um programa
Crie um programa em um locatário.
Atualizar um programa
Atualize um programa existente em um locatário.
Excluir programas
Exclua uma lista de programas em um locatário.
Excluir um programa
Excluir um programa em um locatário.
Obter pedidos
Obtenha uma lista de solicitações em um locatário.
Receba um pedido
Obtenha uma única solicitação em um locatário.
Criar um pedido
Crie uma solicitação em um locatário.
Atualizar um pedido
Atualize uma única solicitação em um locatário.
Eliminar um pedido
Exclua uma única solicitação em um locatário.
Pedidos de eliminação
Exclua uma lista de solicitações em um locatário.
Obter tarefas
Obtenha uma lista de tarefas em um locatário.
Obter uma tarefa
Obtenha uma única tarefa em um locatário.
Criar uma tarefa
Crie uma tarefa em um locatário.
Atualizar uma tarefa
Atualizar uma única tarefa em um locatário.
Eliminar uma tarefa
Exclua uma única tarefa em um locatário.
Excluir tarefas
Exclua uma lista de tarefas em um locatário.
Obter esquemas de status
Obtenha uma lista de esquemas de status.
Obter esquema de status
Obter um único esquema de status
Gatilho: Quando um programa é criado
Um gatilho que usa o webhook ProgramCreate para retornar dados do programa depois que ele foi criado
Gatilho: Quando um programa é atualizado
Um gatilho que usa o webhook ProgramUpdate para retornar dados do programa depois que ele foi atualizado
Gatilho: Quando um programa é excluído
Um gatilho que usa o webhook ProgramDelete para retornar dados do programa depois que ele foi excluído
Gatilho: Quando uma tarefa é criada
Um gatilho que usa o webhook ProgramTaskCreate para retornar dados da tarefa depois que ele foi criado
Gatilho: Quando uma tarefa é atualizada
Um gatilho que usa o webhook ProgramTaskUpdate para retornar dados da tarefa depois que ele foi atualizado
Gatilho: Quando uma tarefa é excluída
Um gatilho que usa o webhook ProgramTaskDelete para retornar dados da tarefa depois que eles foram excluídos
Gatilho: Quando uma solicitação é criada
Um gatilho que usa o webhook ProgramRequestCreate para retornar dados de solicitação depois que ele foi criado
Gatilho: Quando uma solicitação é atualizada
Um gatilho que usa o webhook ProgramRequestUpdate para retornar dados de solicitação depois que ele foi atualizado
Gatilho: quando uma solicitação é excluída
Um gatilho que usa o webhook ProgramRequestDelete para retornar dados de solicitação depois que eles foram excluídos
Obtenção de credenciais
Você precisa de uma conta de usuário Seismic Premium para o locatário. Entre em contato com o administrador do sistema Seismic se você não tiver permissões suficientes.
Introdução
O conector de Programas Sísmicos inclui as seguintes ações. Cada ação corresponde a um ponto de extremidade da API. Consulte o artigo para cada ponto de extremidade de API correspondente para obter mais informações sobre os campos e propriedades associados à ação.
- Receba comentários
- Receba um comentário
- Criar um comentário
- Atualizar um comentário
- Excluir um comentário
- Obter programas
- Obter um programa
- Criar um programa
- Atualizar um programa
- Excluir programas
- Excluir um programa
- Obter pedidos
- Receba um pedido
- Criar um pedido
- Atualizar um pedido
- Excluir solicitações
- Eliminar um pedido
- Obter tarefas
- Obter uma tarefa
- Criar uma tarefa
- Atualizar uma tarefa
- Excluir tarefas
- Eliminar uma tarefa
- Gatilho: criar programa
- Gatilho: atualização do programa
- Gatilho: exclusão do programa
- Gatilho: criação de tarefas
- Gatilho: atualização de tarefas
- Gatilho: exclusão de tarefas
- Gatilho: solicitação de criação
- Gatilho: solicitar atualização
- Gatilho: solicitar exclusão
Problemas conhecidos e limitações
Nenhum problema ou limitação é conhecido no momento. Todas as APIs operam de acordo com a política da API Sísmica, incluindo os Limites de Taxa. Consulte o portal do desenvolvedor sísmico para obter especificações, restrições e padrões da API.
Instruções de implantação
Utilize estas instruções para implementar este conector como um conector personalizado no Microsoft Power Automate e Power Apps.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar comentário |
Atualize um comentário existente. Requer nó (programa, tarefa ou solicitação) e ID de comentário. |
| Atualizar um programa |
Atualize e devolva um programa. |
| Criar comentário |
Crie um comentário sobre um determinado programa, tarefa ou solicitação. Requer ID de nó (programa, tarefa ou solicitação). |
| Criar pedido |
Crie uma solicitação. |
| Criar programa |
Crie um programa. |
| Criar tarefa |
Crie uma tarefa. |
| Excluir comentário |
Excluir um comentário. Requer nó (programa, tarefa ou solicitação) e ID de comentário. |
| Excluir programa |
Excluir um programa. |
| Excluir programas |
Exclua um ou mais programas. |
| Excluir solicitação |
Excluir uma solicitação. |
| Excluir tarefa |
Excluir uma tarefa. |
| Obter esquema de status |
Obtenha um único esquema de status por ID. Esses esquemas armazenam os dados para definir status para trabalhos específicos. Exemplo: |
| Obter esquemas de status |
Obtenha uma lista de esquemas de status de tarefas/solicitações. Esses esquemas armazenam os dados para definir status para trabalhos específicos. Exemplo: |
| Obter pedido |
Obtenha um único pedido. |
| Obter pedidos |
Obtenha uma lista de pedidos. |
| Obter programa |
Obtenha um único programa por ID. Retornar tarefas, se desejar. |
| Obter programas |
Obtenha uma lista de programas com seus atributos e associações. |
| Obter tarefa |
Obtenha uma única tarefa por ID. |
| Obter tarefas |
Obtenha uma lista de tarefas. |
| Pedido de atualização |
Atualize uma solicitação. |
| Pedidos de eliminação |
Solicitações de exclusão em massa. |
| Receba comentários |
Obtenha todos os comentários de um determinado programa, tarefa ou solicitação. Requer ID de nó (programa, tarefa ou solicitação). |
| Receber comentário |
Receba um único comentário. Requer nó (programa, tarefa ou solicitação) e ID de comentário. |
| Tarefa de atualização |
Atualizar uma tarefa existente. |
Atualizar comentário
Atualize um comentário existente. Requer nó (programa, tarefa ou solicitação) e ID de comentário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do nó
|
nodeId | True | string |
ID do nó |
|
ID do comentário
|
commentId | True | string |
ID do comentário |
|
Carga útil de anotação
|
annotationPayload | string | ||
|
Tipo de anotação
|
annotationType | string | ||
|
Conteúdo do comentário
|
commentContent | True | string |
Conteúdo do comentário |
|
está resolvido
|
isResolved | boolean |
Verdadeiro/falso sobre se o comentário foi resolvido |
Devoluções
- Body
- Comment
Atualizar um programa
Atualize e devolva um programa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do programa
|
programId | True | string |
ID do programa |
|
ID do tipo de fase
|
phaseTypeId | True | string |
ID do tipo de fase |
|
ID do espaço
|
spaceId | string |
ID do espaço |
|
|
Data e hora
|
datetime | date-time |
Data e hora da fase |
|
|
Nome
|
name | string |
Nome da fase |
|
|
associatedToField
|
associatedToField | string |
O campo ao qual a fase está associada vem de PhaseType |
|
|
Description
|
description | string |
Descrição da fase que vem de PhaseType |
|
|
Cor
|
color | string |
Cor da fase que vem de PhaseType |
|
|
Ordinalidade
|
ordinality | integer |
Ordem de fase que vem de PhaseType |
|
|
Arquivado
|
archived | boolean |
Indicador sobre se um programa está arquivado ou não |
|
|
Ativado(a)
|
enabled | boolean |
Indicador preterido para arquivamento |
|
|
Ocultar Dicas
|
hideTips | boolean |
Indicador se o usuário tem dicas ocultas ou não |
|
|
Data de Lançamento
|
launchDate | date-time |
Data de lançamento |
|
|
Tipo
|
type | string |
Tipo de objeto de audiência |
|
|
ID
|
id | string |
ID do público (grupo de utilizadores, utilizador, etc.) |
|
|
Rastreadores
|
trackers | array of string |
Lista de rastreadores de palavras-chave |
|
|
Tópicos
|
topics | array of string |
Lista de tópicos de palavras-chave |
|
|
Tipo de Programa
|
programType | string |
Tipo de programa |
|
|
Primeira métrica de KPI de resultado
|
outcomeKpiFirst | string |
Primeira métrica de KPI de resultado |
|
|
Segunda métrica de KPI de resultado
|
outcomeKpiSecond | string |
Segunda métrica de KPI de resultado |
|
|
Terceira métrica de KPI de resultado
|
outcomeKpiThird | string |
Terceira métrica de KPI de resultado |
|
|
Tipo de métrica
|
metricType | string |
Tipo de métrica |
|
|
Valor alvo
|
targetValue | string |
Valor de destino do número especificado pelo usuário para o objetivo |
|
|
Medido em
|
measuredIn | string |
Opção para definir como a métrica é medida |
|
|
Tendência
|
trend | string |
Opção para definir como a tendência objetiva está sendo rastreada |
|
|
Intervalo de datas
|
dateRange | string |
Intervalo de datas definido para a tendência |
|
|
Ocultar da visão geral
|
isHideFromOverView | boolean |
Opção para ocultar o objetivo métrico da página de visão geral |
|
|
Description
|
description | string |
Descrição da associação |
|
|
Nome
|
name | string |
Nome da associação |
|
|
GUID do nó
|
nodeGuid | string |
Formato GUID mais longo |
|
|
ID do nó
|
nodeId | string |
ID do nó |
|
|
Tipo de nó
|
nodeType | string |
Tipo de nó da associação |
|
|
GUID de espaço
|
spaceGuid | string |
Formato GUID mais longo |
|
|
ID do espaço
|
spaceId | string |
ID do espaço |
|
|
ID de propriedade personalizada
|
id | string | ||
|
Localizações
|
localizations | object |
Objeto de localização |
|
|
Valor múltiplo
|
multipleValue | boolean |
Indicar se a propriedade personalizada permite vários valores |
|
|
Nome
|
name | string |
Nome da propriedade personalizada |
|
|
ID do valor
|
id | string | ||
|
Valor
|
value |
Dados de valor para valor de propriedade personalizada |
||
|
Description
|
description | string |
Descrição do programa |
|
|
Está ativo
|
isActive | boolean |
Indicador sobre se um programa está ativo? |
|
|
ID do Gestor
|
managerId | string |
ID de utilizador do gestor do programa |
|
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data da data de término planejada |
|
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data da data de início planejada |
|
|
Title
|
title | True | string |
Título do programa |
Devoluções
- Body
- Program
Criar comentário
Crie um comentário sobre um determinado programa, tarefa ou solicitação. Requer ID de nó (programa, tarefa ou solicitação).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do nó
|
nodeId | True | string |
ID do nó |
|
Carga útil de anotação
|
annotationPayload | string | ||
|
Tipo de anotação
|
annotationType | string |
Tipo de anotação |
|
|
Conteúdo do comentário
|
commentContent | True | string |
Conteúdo do comentário |
|
está resolvido
|
isResolved | boolean |
Verdadeiro/falso sobre se o comentário foi resolvido |
Devoluções
- Body
- Comment
Criar pedido
Crie uma solicitação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do cessionário
|
assigneeId | string |
ID de utilizador do cessionário |
|
|
ID do nó
|
nodeId | string |
ID do nó |
|
|
Tipo de nó
|
nodeType | string |
Tipo de nó da associação |
|
|
ID do espaço
|
spaceId | string |
ID do espaço |
|
|
ID do conteúdo
|
contentId | uuid |
ID do conteúdo |
|
|
Caminho completo do DocCenter
|
docCenterFullPath | string |
Caminho de localização completo de onde o conteúdo existe no DocCenter |
|
|
Versão principal
|
majorVersion | integer |
Número da versão principal |
|
|
Versão Menor
|
minorVersion | integer |
Número de versões secundárias |
|
|
Data de Modificação
|
modifiedDate | date-time |
Data da última atualização da referência de conteúdo |
|
|
Número da encomenda
|
orderNo | integer |
Número para indicar a ordem |
|
|
ID do perfil
|
profileId | uuid |
ID do perfil |
|
|
ID da versão do perfil
|
profileVersionId | uuid |
ID da versão do perfil |
|
|
Fonte
|
source | string |
Fonte do conteúdo |
|
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
|
ID da miniatura
|
thumbnailId | string |
ID da miniatura da imagem |
|
|
ID da versão
|
versionId | uuid |
ID da versão do conteúdo |
|
|
ID de propriedade personalizada
|
id | string | ||
|
ID do valor
|
id | string | ||
|
Valor
|
value |
Dados de valor para valor de propriedade personalizada |
||
|
Referência do formulário
|
formRef | True |
Objeto de referência de formulário |
|
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data de término |
|
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data de início |
|
|
Priority
|
priority | string |
Valor prioritário |
|
|
ID do programa
|
programId | string |
ID do programa ao qual o pedido pertence |
|
|
ID do esquema de status
|
statusSchemaId | string | ||
|
Title
|
title | True | string |
Título do pedido |
Devoluções
- Body
- ProgramRequest
Criar programa
Crie um programa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do nó
|
nodeId | string |
ID do nó |
|
|
Tipo de nó
|
nodeType | string |
Tipo de nó da associação |
|
|
ID do espaço
|
spaceId | string |
ID do espaço |
|
|
ID de propriedade personalizada
|
id | string | ||
|
ID do valor
|
id | string | ||
|
Valor
|
value |
Dados de valor para valor de propriedade personalizada |
||
|
Description
|
description | string |
Título da descrição |
|
|
ID do Gestor
|
managerId | string |
ID de utilizador do gestor |
|
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data de término |
|
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data de início |
|
|
Title
|
title | True | string |
Título do programa |
Devoluções
- Body
- Program
Criar tarefa
Crie uma tarefa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do cessionário
|
assigneeId | string |
ID de utilizador do cessionário |
|
|
ID do nó
|
nodeId | string |
ID do nó |
|
|
Tipo de nó
|
nodeType | string |
Tipo de nó da associação |
|
|
ID do espaço
|
spaceId | string |
ID do espaço |
|
|
ID de propriedade personalizada
|
id | string | ||
|
ID do valor
|
id | string | ||
|
Valor
|
value |
Dados de valor para valor de propriedade personalizada |
||
|
Description
|
description | string |
Descrição da tarefa |
|
|
ID do pai
|
parentId | string |
ID da tarefa pai |
|
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data de término |
|
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data de início |
|
|
Priority
|
priority | string |
Valores de prioridade |
|
|
ID do programa
|
programId | string |
ID do programa ao qual a tarefa está associada |
|
|
Title
|
title | True | string |
Título da tarefa |
Devoluções
- Body
- ProgramTask
Excluir comentário
Excluir um comentário. Requer nó (programa, tarefa ou solicitação) e ID de comentário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do nó
|
nodeId | True | string |
ID do nó |
|
ID do comentário
|
commentId | True | string |
ID do comentário |
Excluir programa
Excluir um programa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do programa
|
programId | True | string |
ID do programa |
|
Excluir tarefas
|
deleteTasks | boolean |
Excluir também tarefas associadas |
Devoluções
Excluir programas
Exclua um ou mais programas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
IDs do programa
|
ids | True | array |
Lista de IDs de programa |
|
Excluir tarefas
|
deleteTasks | boolean |
Excluir também tarefas associadas |
Devoluções
Excluir solicitação
Excluir uma solicitação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID de solicitação
|
requestId | True | string |
ID de solicitação |
Excluir tarefa
Excluir uma tarefa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID da tarefa
|
taskId | True | string |
ID da tarefa |
Devoluções
Obter esquema de status
Obtenha um único esquema de status por ID. Esses esquemas armazenam os dados para definir status para trabalhos específicos.
Exemplo: (Not started, In progress, Complete)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do esquema de status
|
statusSchemaId | True | string |
ID do esquema de status |
Devoluções
- Body
- StatusSchema
Obter esquemas de status
Obtenha uma lista de esquemas de status de tarefas/solicitações. Esses esquemas armazenam os dados para definir status para trabalhos específicos.
Exemplo: (Not started, In progress, Complete)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
É padrão
|
isDefault | boolean |
Obter esquema de status padrão |
|
|
Tipo
|
type | string |
Consulta por tipo de nó |
|
|
IDS do esquema de status
|
ids | array |
Lista de IDs de esquemas de status |
|
|
IDs de criador
|
creatorIds | array |
Lista de IDs de usuário a serem consultados pelo criador |
|
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
|
Limite
|
limit | integer |
Número para limitar os registos devolvidos |
Devoluções
Obter pedido
Obtenha um único pedido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID de solicitação
|
requestId | True | string |
ID de solicitação |
Devoluções
- Body
- ProgramRequest
Obter pedidos
Obtenha uma lista de pedidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
Data de término planejada a partir de
|
plannedEndDateFrom | date-time |
filtrar por data de vencimento do pedido (inclusive) |
|
|
Data de término planejada para
|
plannedEndDateTo | date-time |
Filtrar por Data de Vencimento da Solicitação (Exclusivo) |
|
|
Data de início prevista a partir de
|
plannedStartDateFrom | date-time |
filtrar por data de início do pedido (inclusive) |
|
|
Data de início prevista para
|
plannedStartDateTo | date-time |
Filtrar por Pedido Data de Início (Exclusivo) |
|
|
Criado em A partir de
|
createdAtFrom | date-time |
filtrar por data de criação do pedido (inclusive) |
|
|
Criado em To
|
createdAtTo | date-time |
Filtrar por Pedido Data de Criação (Exclusivo) |
|
|
Atualizado em De
|
updatedAtFrom | date-time |
filtrar por pedido data de atualização (inclusive) |
|
|
Atualizado em To
|
updatedAtTo | date-time |
Filtrar por Pedido Data de Atualização (Exclusivo) |
|
|
IDs de solicitação
|
ids | array |
Uma lista de IDs de solicitação |
|
|
Title
|
title | string |
Valores de palavras-chave para pesquisar títulos sob solicitação |
|
|
IDs do cessionário
|
assigneeIds | array |
Uma lista de IDs de usuário dos cessionários para filtrar por |
|
|
Prioridades
|
priorities | array |
Uma lista de valores de prioridade, Valores disponíveis: crítico, alto, médio, baixo |
|
|
Palavras-chave
|
keywords | string |
Valores de palavras-chave a pesquisar |
|
|
IDs do cedente
|
assignerIds | array |
Uma lista de IDs de usuário do cedente para filtrar por |
|
|
IDs de criador
|
creatorIds | array |
Uma lista de IDs de usuário dos criadores para filtrar |
|
|
IDs de etapa
|
stepIds | array |
Uma lista de IDs de etapa para filtrar por |
|
|
ID do esquema de status
|
statusSchemaId | string |
ID do esquema de status a ser filtrado por |
|
|
Cursor
|
cursor | string |
Um token usado para guiar a janela da próxima página |
|
|
Limite
|
limit | integer |
Número de itens a retornar por página, padrão: 50 |
|
|
Ordenar
|
sort | array |
Ordenar por pedidos |
|
|
ID do programa
|
programId | string |
A ID do programa à qual uma solicitação está associada |
|
|
Tem Programa
|
hasProgram | boolean |
Filtrar por se as solicitações estiverem associadas a um programa |
|
|
Propriedades personalizadas
|
customProperties | string |
Filtrar por propriedades personalizadas |
|
|
IDs de seguidor
|
followerIds | array |
Uma lista do ID de utilizador dos seguidores |
|
|
IDs de nó associados
|
associatedNodeIds | array |
Uma lista de IDs de nó associados para filtrar por |
|
|
Objetos de referência de conteúdo
|
contentRefs | array |
Lista de objetos de referência de conteúdo |
|
|
Incluir propriedades personalizadas do formulário de solicitação
|
includeRequestFormCustomProperties | boolean |
se as propriedades personalizadas do formulário de solicitação devem ser incluídas, false padrão |
Devoluções
Obter programa
Obtenha um único programa por ID. Retornar tarefas, se desejar.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do programa
|
programId | True | string |
ID do programa |
|
Profundidade dos nós associados
|
associatedNodesDepth | integer |
Número para indicar a profundidade dos dados de nó associados retornados |
|
|
Incluir Obras
|
includeWorks | boolean |
Indicador para incluir dados de tarefas associadas |
Devoluções
- Body
- Program
Obter programas
Obtenha uma lista de programas com seus atributos e associações.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
Data de término planejada a partir de
|
plannedEndDateFrom | date-time |
Filtrar a partir de uma data de término planejada |
|
|
Data de término planejada para
|
plannedEndDateTo | date-time |
Filtrar para uma data de término planejada |
|
|
Data de início prevista a partir de
|
plannedStartDateFrom | date-time |
Filtrar a partir de uma data de início planeada |
|
|
Data de início prevista para
|
plannedStartDateTo | date-time |
Filtrar para uma data de início planeada |
|
|
Data de lançamento a partir de
|
launchDateFrom | date-time |
Filtrar a partir de uma data de lançamento |
|
|
Data de lançamento para
|
launchDateTo | date-time |
Filtrar para uma data de lançamento |
|
|
IDs do programa
|
ids | array |
Lista de IDs de programa para consulta por |
|
|
Título do Programa
|
title | string |
Título do programa para consulta por |
|
|
IDs do gerente
|
managerIds | array |
Lista de IDs de usuário a serem consultados pelo gerente |
|
|
IDs de criador
|
creatorIds | array |
Lista de IDs de usuário a serem consultados pelo criador |
|
|
IDs de nó associados
|
associatedNodeIds | array |
Lista de IDs de associação a consultar por |
|
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
|
Limite
|
limit | integer |
Número para limitar os registos devolvidos |
|
|
Ordenar
|
sort | array |
Ordenar consulta |
|
|
Propriedades personalizadas
|
customProperties | string |
Lista de propriedades personalizadas a serem consultadas por |
|
|
IDs de seguidor
|
followerIds | array |
Lista de IDs de usuário a serem consultados por seguidor |
|
|
Arquivado
|
archived | boolean |
Lista de programas arquivados ou não arquivados |
|
|
Audiência
|
audience | array |
Lista de IDs de usuário de audiência do programa a serem consultados por |
|
|
Tipo de Programa
|
programType | string |
ProgramType enum para consulta por |
|
|
Primeira métrica de KPI de resultado
|
outcomeKpiFirst | string |
Primeiro resultado KPI Metric enum para consulta por |
|
|
Segunda métrica de KPI de resultado
|
outcomeKpiSecond | string |
Segundo resultado KPI Métrica enum para consulta por |
|
|
Terceira métrica de KPI de resultado
|
outcomeKpiThird | string |
Terceiro resultado KPI Enum métrico para consulta por |
|
|
Fases Atuais
|
currentPhases | array |
Uma lista de IDs de fase atuais para consulta por |
|
|
Incluir Associações
|
includeAssociations | boolean |
Indicador para permitir a inclusão de dados de associação |
|
|
Incluir arquivado
|
includeDeactivatedPrograms | boolean |
Indicador para permitir a inclusão de programas arquivados (ignorado quando ativado é passado) |
|
|
Incluir páginas
|
includePages | boolean |
Indicador para permitir a inclusão de dados de páginas |
Devoluções
- Body
- ProgramQueryResponse
Obter tarefa
Obtenha uma única tarefa por ID.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID da tarefa
|
taskId | True | string |
ID da tarefa |
Devoluções
- Body
- ProgramTask
Obter tarefas
Obtenha uma lista de tarefas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
Data de término planejada a partir de
|
plannedEndDateFrom | date-time |
Filtrar por data de conclusão da tarefa (inclusive) |
|
|
Data de término planejada para
|
plannedEndDateTo | date-time |
Filtrar por data de conclusão da tarefa (exclusivo) |
|
|
Data de início prevista a partir de
|
plannedStartDateFrom | date-time |
Filtrar por data de início da tarefa (inclusive) |
|
|
Data de início prevista para
|
plannedStartDateTo | date-time |
Filtrar por data de início da tarefa (exclusivo) |
|
|
Criado em A partir de
|
createdAtFrom | date-time |
Filtrar por data de criação da tarefa (inclusive) |
|
|
Criado em To
|
createdAtTo | date-time |
Filtrar por data de criação da tarefa (exclusivo) |
|
|
Atualizado em De
|
updatedAtFrom | date-time |
Filtrar por data de atualização da tarefa (inclusive) |
|
|
Atualizado em To
|
updatedAtTo | date-time |
Filtrar por tarefa data de atualização (exclusivo) |
|
|
IDs de tarefas
|
ids | array |
Filtrar por uma lista de IDs de tarefas |
|
|
Title
|
title | string |
Filtrar por título da tarefa |
|
|
Description
|
description | string |
Filtrar por descrição da tarefa |
|
|
IDs do cessionário
|
assigneeIds | array |
Lista de IDs de usuário a serem filtrados por cessionário |
|
|
Prioridades
|
priorities | array |
Filtrar por lista de prioridades |
|
|
Palavras-chave
|
keywords | string |
Filtrar por palavras-chave |
|
|
IDs do cedente
|
assignerIds | array |
Lista de IDs de usuário a serem filtrados por usuário que atribuiu a tarefa |
|
|
IDs de etapa
|
stepIds | array |
Filtrar por IDs de valor de status |
|
|
ID do esquema de status
|
statusSchemaId | string |
Filtrar por IDs de esquema de status |
|
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
|
Limite
|
limit | integer |
Número para limitar os registos devolvidos |
|
|
Ordenar
|
sort | array |
Ordenar por consulta |
|
|
Recursivo
|
recursive | boolean |
Incluir subtarefas na lista retornada |
|
|
ID do programa
|
programId | string |
Filtrar por ID do programa |
|
|
Tem Programa
|
hasProgram | boolean |
Filtrar por tarefas associadas a um programa |
|
|
Propriedades personalizadas
|
customProperties | string |
Filtrar por valores de propriedade personalizados |
|
|
IDs de seguidor
|
followerIds | array |
Lista de IDs de utilizador a filtrar por seguidores |
|
|
IDs de nó associados
|
associatedNodeIds | array |
Lista de IDs de associação a filtrar por |
|
|
IDs de criador
|
creatorIds | array |
Lista de IDs de usuário a serem filtrados por criador |
|
|
Incluir Associações
|
includeAssociations | boolean |
Incluir dados de associação na resposta |
|
|
ID do pai
|
parentId | string |
Lista de IDs de tarefas a filtrar por |
Devoluções
Pedido de atualização
Atualize uma solicitação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID de solicitação
|
requestId | True | string |
ID de solicitação |
|
ID do cessionário
|
assigneeId | string |
ID de utilizador do cessionário |
|
|
ID do conteúdo
|
contentId | uuid |
ID do conteúdo |
|
|
Caminho completo do DocCenter
|
docCenterFullPath | string |
Caminho de localização completo de onde o conteúdo existe no DocCenter |
|
|
Versão principal
|
majorVersion | integer |
Número da versão principal |
|
|
Versão Menor
|
minorVersion | integer |
Número de versões secundárias |
|
|
Data de Modificação
|
modifiedDate | date-time |
Data da última atualização da referência de conteúdo |
|
|
Número da encomenda
|
orderNo | integer |
Número para indicar a ordem |
|
|
ID do perfil
|
profileId | uuid |
ID do perfil |
|
|
ID da versão do perfil
|
profileVersionId | uuid |
ID da versão do perfil |
|
|
Fonte
|
source | string |
Fonte do conteúdo |
|
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
|
ID da miniatura
|
thumbnailId | string |
ID da miniatura da imagem |
|
|
ID da versão
|
versionId | uuid |
ID da versão do conteúdo |
|
|
ID de propriedade personalizada
|
id | string | ||
|
ID do valor
|
id | string | ||
|
Valor
|
value |
Dados de valor para valor de propriedade personalizada |
||
|
Referência do formulário
|
formRef | True |
Objeto de referência de formulário |
|
|
Observação
|
note | string |
Nota utilizada para notificações sobre alterações de estado |
|
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Sequência de datas da data de término planejada (data de vencimento) |
|
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data da data de início planejada |
|
|
Priority
|
priority | string |
Valor prioritário |
|
|
ID do programa
|
programId | string |
ID do programa ao qual a solicitação pertence |
|
|
ID do passo
|
stepId | True | integer |
ID do passo que indica o estado |
|
Title
|
title | True | string |
Título do pedido |
Devoluções
- Body
- ProgramRequest
Pedidos de eliminação
Solicitações de exclusão em massa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
Tipo de conteúdo
|
Content-Type | string |
Tipo de conteúdo |
|
|
IDs de solicitação
|
ids | array of string |
Lista de IDs de solicitação a serem excluídas |
Devoluções
Receba comentários
Obtenha todos os comentários de um determinado programa, tarefa ou solicitação. Requer ID de nó (programa, tarefa ou solicitação).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do nó
|
nodeId | True | string |
ID do nó |
|
IDs de criador
|
creatorIds | array |
Lista de IDs de usuário a serem consultados pelo criador |
|
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
|
Limite
|
limit | integer |
Número para limitar registos |
|
|
Ordenar
|
sort | array |
Ordenar por consulta |
Devoluções
- Body
- CommentQueryResponse
Receber comentário
Receba um único comentário. Requer nó (programa, tarefa ou solicitação) e ID de comentário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID do nó
|
nodeId | True | string |
ID do nó |
|
ID do comentário
|
commentId | True | string |
ID do comentário |
Devoluções
- Body
- Comment
Tarefa de atualização
Atualizar uma tarefa existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
spaceId | True | string |
ID do espaço |
|
ID da tarefa
|
taskId | True | string |
ID da tarefa |
|
ID do cessionário
|
assigneeId | string |
ID de utilizador do cessionário |
|
|
ID de propriedade personalizada
|
id | string | ||
|
ID do valor
|
id | string | ||
|
Valor
|
value |
Dados de valor para valor de propriedade personalizada |
||
|
Description
|
description | string |
Descrição da tarefa |
|
|
ID do pai
|
parentId | string |
ID da tarefa pai |
|
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data da data de término planejada |
|
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data da data de início planejada |
|
|
Priority
|
priority | string |
Valor prioritário |
|
|
ID do programa
|
programId | string |
ID do programa ao qual a tarefa pertence |
|
|
ID do passo
|
stepId | integer |
ID da etapa indicando o status da tarefa |
|
|
Title
|
title | True | string |
Título da tarefa |
Devoluções
- Body
- ProgramTask
Acionadores
| Quando um pedido é atualizado |
Gatilho para responder quando uma solicitação é atualizada |
| Quando um pedido é eliminado |
Gatilho para responder quando uma solicitação é excluída |
| Quando um programa é atualizado |
Gatilho para responder quando um programa é atualizado |
| Quando um programa é criado |
Gatilho para responder quando um programa é criado |
| Quando um programa é excluído |
Gatilho para responder quando um programa é excluído |
| Quando uma solicitação é criada |
Gatilho para responder quando uma solicitação é criada |
| Quando uma tarefa é atualizada |
Gatilho para responder quando uma tarefa é atualizada |
| Quando uma tarefa é criada |
Gatilho para responder quando uma tarefa é criada |
| Quando uma tarefa é eliminada |
Gatilho para responder quando uma tarefa é excluída |
Quando um pedido é atualizado
Gatilho para responder quando uma solicitação é atualizada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | RequestWebhookResponse |
Quando um pedido é eliminado
Gatilho para responder quando uma solicitação é excluída
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | RequestWebhookResponse |
Quando um programa é atualizado
Gatilho para responder quando um programa é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | ProgramWebhookResponse |
dados |
Quando um programa é criado
Gatilho para responder quando um programa é criado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | ProgramWebhookResponse |
dados |
Quando um programa é excluído
Gatilho para responder quando um programa é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | ProgramWebhookResponse |
dados |
Quando uma solicitação é criada
Gatilho para responder quando uma solicitação é criada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | RequestWebhookResponse |
Quando uma tarefa é atualizada
Gatilho para responder quando uma tarefa é atualizada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | TaskWebhookResponse |
Quando uma tarefa é criada
Gatilho para responder quando uma tarefa é criada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | TaskWebhookResponse |
Quando uma tarefa é eliminada
Gatilho para responder quando uma tarefa é excluída
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
filtro
|
filter | string |
Exemplo: $.data.. [? (@.id == 'foo')] , expressão de filtro baseada em JsonPath, consulte https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events para obter detalhes. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
Um identificador exclusivo para o evento. |
|
versão
|
version | string |
A versão do evento, por exemplo, "ProgramCreateV1". |
|
ocorreuEm
|
occurredAt | date-time |
Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC. |
|
tenantId
|
tenantId | uuid |
Identificador exclusivo para o locatário. |
|
Nome do locatário
|
tenantName | string |
Nome do inquilino. |
|
aplicação
|
application | string |
O pedido de origem do evento. |
|
productArea
|
productArea | string |
A área de produto relacionada com o evento. |
|
dados
|
data | TaskWebhookResponse |
Definições
Associação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Description
|
description | string |
Descrição da associação |
|
Nome
|
name | string |
Nome da associação |
|
GUID do nó
|
nodeGuid | string |
Formato GUID mais longo |
|
ID do nó
|
nodeId | string |
ID do nó |
|
Tipo de nó
|
nodeType | string |
Tipo de nó da associação |
|
GUID de espaço
|
spaceGuid | string |
Formato GUID mais longo |
|
ID do espaço
|
spaceId | string |
ID do espaço |
AsyncOperationResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
IDs de operação assíncrona
|
asyncOperationIds | array of string |
Lista de IDs de ação assíncrona |
Audiência
Objeto de audiência
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
type | string |
Tipo de objeto de audiência |
|
ID
|
id | string |
ID do público (grupo de utilizadores, utilizador, etc.) |
Comment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Carga útil de anotação
|
annotationPayload | string | |
|
Tipo de anotação
|
annotationType | string | |
|
Conteúdo do comentário
|
commentContent | string | |
|
Criado em
|
createdAt | date-time |
Cadeia de caracteres de data de criação |
|
ID do criador
|
creatorId | string |
ID de utilizador do criador |
|
ID do comentário
|
id | string |
ID do comentário |
|
está resolvido
|
isResolved | boolean |
Verdadeiro/falso sobre se o comentário foi resolvido |
|
ID do nó
|
nodeId | string |
ID do nó |
|
Tipo de nó
|
nodeType | string |
Tipo de nó do comentário |
|
Índice da página
|
pageIndex | string |
Índice de páginas numéricas |
|
ID do pai
|
parentId | string |
ID do comentário pai |
|
Contagem de respostas
|
replyCount | integer |
Número de respostas |
|
ID do espaço
|
spaceId | string |
ID do espaço |
|
Atualizado em
|
updatedAt | date-time |
Sequência de data da data atualizada |
CommentQueryResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de registos devolvidos |
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
Itens
|
items | array of Comment |
Lista de itens na resposta |
|
Limite
|
limit | integer |
Número para limitar registos |
|
Objeto de metadados
|
meta | Meta |
Objeto de metadados |
ContentRef
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do conteúdo
|
contentId | uuid |
ID do conteúdo |
|
Caminho completo do DocCenter
|
docCenterFullPath | string |
Caminho de localização completo de onde o conteúdo existe no DocCenter |
|
Versão principal
|
majorVersion | integer |
Número da versão principal |
|
Versão Menor
|
minorVersion | integer |
Número de versões secundárias |
|
Data de Modificação
|
modifiedDate | date-time |
Data da última atualização da referência de conteúdo |
|
Número da encomenda
|
orderNo | integer |
Número para indicar a ordem |
|
ID do perfil
|
profileId | uuid |
ID do perfil |
|
ID da versão do perfil
|
profileVersionId | uuid |
ID da versão do perfil |
|
Fonte
|
source | string |
Fonte do conteúdo |
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
ID da miniatura
|
thumbnailId | string |
ID da miniatura da imagem |
|
ID da versão
|
versionId | uuid |
ID da versão do conteúdo |
Propriedade Personalizada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Permitir vários valores
|
allowMultipleValues | boolean |
Indica se a propriedade personalizada permite vários valores |
|
Criado por ID
|
createdById | string |
ID de utilizador do criador |
|
Tem domínio de valores
|
hasDomainOfValues | boolean |
Indica se a propriedade personalizada tem valores possíveis |
|
Hint
|
hint | string |
Valor que descreve a dica exibida sob o nome da propriedade personalizada |
|
ID de propriedade personalizada
|
id | string | |
|
é obrigatório
|
isRequired | boolean |
Indica se a propriedade personalizada é necessária ou não |
|
Última modificação por ID
|
lastModifiedById | string |
ID de usuário do usuário que atualizou a propriedade personalizada pela última vez |
|
Nome
|
name | string |
Nome da propriedade personalizada |
|
Configuração da operação
|
operationSetting | string |
Objeto que descreve configurações para diferentes operações em uma propriedade personalizada |
|
Encomenda
|
order | integer |
Número que indica a ordem na lista de propriedades personalizadas |
|
Valores Possíveis
|
possibleValues | array of PossibleValuesItem |
Lista de valores possíveis para a propriedade personalizada (se aplicável) |
|
Configurações de escopo
|
scopeSettings | array of ScopeSettingsItemDefinition |
Objeto que descreve configurações para escopos diferentes em uma propriedade personalizada |
|
Alcances
|
scopes | array of string |
Lista de âmbitos |
|
Nome do esquema de valor
|
valueSchemaName | string |
Nome do esquema de valor da propriedade personalizada |
|
valueSchemaProperty
|
valueSchemaProperty | ValueSchemaPropertyDefinition |
Definição de esquema de valor |
|
Tipo de valor
|
valueType | string |
Tipo de valor da propriedade personalizada |
CustomPropertyValues
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de propriedade personalizada
|
id | string | |
|
Localizações
|
localizations | object |
Objeto de localização |
|
Valor múltiplo
|
multipleValue | boolean |
Indicar se a propriedade personalizada permite vários valores |
|
Nome
|
name | string |
Nome da propriedade personalizada |
|
Valores
|
values | array of CustomPropertyValuesValues |
Lista de valores de propriedade personalizada |
CustomPropertyValuesValues
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do valor
|
id | string | |
|
Valor
|
value |
Dados de valor para valor de propriedade personalizada |
Follower
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do usuário/grupo de usuários
|
id | string |
ID do usuário/grupo de usuários do seguidor |
|
Tipo
|
type | string |
Tipo de seguidor de usuário ou grupo de usuários |
Meta
Objeto de metadados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de registos devolvidos |
|
Query
|
query | array of MetaQueryInfo |
Objeto de consulta |
MetaQueryInfo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Ordenar
|
sort | array of string |
Ordenar consulta |
MetricObjective
Objeto objetivo métrico
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de métrica
|
metricType | string |
Tipo de métrica |
|
Valor alvo
|
targetValue | string |
Valor de destino do número especificado pelo usuário para o objetivo |
|
Medido em
|
measuredIn | string |
Opção para definir como a métrica é medida |
|
Tendência
|
trend | string |
Opção para definir como a tendência objetiva está sendo rastreada |
|
Intervalo de datas
|
dateRange | string |
Intervalo de datas definido para a tendência |
|
Ocultar da visão geral
|
isHideFromOverView | boolean |
Opção para ocultar o objetivo métrico da página de visão geral |
Phase
Fase do programa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do tipo de fase
|
phaseTypeId | string |
ID do tipo de fase |
|
ID do espaço
|
spaceId | string |
ID do espaço |
|
Data e hora
|
datetime | date-time |
Data e hora da fase |
|
Nome
|
name | string |
Nome da fase |
|
associatedToField
|
associatedToField | string |
O campo ao qual a fase está associada vem de PhaseType |
|
Description
|
description | string |
Descrição da fase que vem de PhaseType |
|
Cor
|
color | string |
Cor da fase que vem de PhaseType |
|
Ordinalidade
|
ordinality | integer |
Ordem de fase que vem de PhaseType |
Programa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Duração real
|
actualDuration | integer |
Duração real calculada em dias |
|
Data de Fim Real
|
actualEndDate | date-time |
Data de término calculada a partir de quando o programa realmente terminou |
|
Data de início real
|
actualStartDate | date-time |
Data de início calculada a partir de quando o programa realmente começou |
|
Configuração analítica
|
analyticSetting | ProgramAnalyticSetting | |
|
Nós associados
|
associatedNodes | array of ProgramAssociatedNodes |
Lista de dados de associação |
|
Associações
|
associations | array of Association |
Lista de associações (Conteúdo da biblioteca) |
|
Copiar de
|
copyFrom | string |
ID do programa do qual o programa é copiado |
|
Criado em
|
createdAt | date-time |
Cadeia de caracteres de data de criação |
|
ID do criador
|
creatorId | string |
ID de utilizador do criador |
|
Propriedades personalizadas
|
customProperties | array of CustomPropertyValues |
Lista de propriedades personalizadas |
|
Breve Descrição
|
description | string |
Breve descrição do programa |
|
Followers
|
followers | array of Follower |
Lista de seguidores |
|
ID do programa
|
id | string | |
|
Está ativo
|
isActive | boolean |
Indicador sobre se um programa está ativo ou não |
|
É modelo
|
isTemplate | boolean |
Indicador sobre se o programa é um modelo ou não |
|
ID do Gestor
|
managerId | string |
ID de utilizador do gestor do programa |
|
Classificação máxima
|
maxRank | string |
Número máximo de classificação |
|
Classificação mínima
|
minRank | string |
Número mínimo de classificação |
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data da data de término planejada |
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data da data de início planejada |
|
ID do espaço
|
spaceId | string | |
|
ID do modelo
|
templateId | string |
ID do modelo a partir do qual o programa foi criado |
|
Title
|
title | string |
Título do programa |
|
Atualizado em
|
updatedAt | date-time |
Data da última atualização do programa |
|
Funciona
|
works | array of ProgramTask |
Lista de tarefas e pedidos |
ProgramAnalyticSetting
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Phase
|
currentPhase | Phase |
Fase do programa |
|
Fases
|
phases | array of Phase |
Lista de possíveis fases do programa |
|
Arquivado
|
archived | boolean |
Indicador sobre se um programa está arquivado ou não |
|
Ativado(a)
|
enabled | boolean |
Indicador preterido para arquivamento |
|
Ocultar Dicas
|
hideTips | boolean |
Indicador se o usuário tem dicas ocultas ou não |
|
Data de Lançamento
|
launchDate | date-time |
Data de lançamento |
|
Audiência
|
audience | array of Audience |
Lista de grupos de usuários para o público do programa |
|
Rastreadores
|
trackers | array of string |
Lista de rastreadores de palavras-chave |
|
Tópicos
|
topics | array of string |
Lista de tópicos de palavras-chave |
|
Tipo de Programa
|
programType | string |
Tipo de programa |
|
Primeira métrica de KPI de resultado
|
outcomeKpiFirst | string |
Primeira métrica de KPI de resultado |
|
Segunda métrica de KPI de resultado
|
outcomeKpiSecond | string |
Segunda métrica de KPI de resultado |
|
Terceira métrica de KPI de resultado
|
outcomeKpiThird | string |
Terceira métrica de KPI de resultado |
|
Objetivos Métricos
|
metricObjectives | array of MetricObjective |
Lista de objetivos métricos |
ProgramQueryResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de registos devolvidos |
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
Objetos do programa
|
items | array of Program |
Lista de itens do programa na resposta |
|
Limite
|
limit | integer |
Número para limitar registos |
|
Objeto de metadados
|
meta | Meta |
Objeto de metadados |
ProgramWebhookResponse
dados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tenantId
|
tenantId | string |
dados/tenantId |
|
Nome do locatário
|
tenantName | string |
nome_dados/inquilino |
|
actorId
|
actorId | string |
dados/actorId |
|
eventTimestamp
|
eventTimestamp | integer |
data/eventTimestamp |
|
Id do programa
|
programId | string |
dados/programId |
|
title
|
title | string |
dados/título |
|
descrição
|
description | string |
dados/descrição |
|
planejadoStartDate
|
plannedStartDate | date-time |
data/planejadoStartDate |
|
planejadoEndDate
|
plannedEndDate | date-time |
data/planejadoEndDate |
|
planeadoDuração
|
plannedDuration | integer |
dados/planeadoDuração |
|
criadorId
|
creatorId | string |
dados/creatorId |
|
criadosAt
|
createdAt | date-time |
dados/criadosAt |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
attachedRequests
|
attachedRequests | array of object |
attachedRequests |
|
spaceId
|
attachedRequests.spaceId | string |
data/attachedRequests/spaceId |
|
requestId
|
attachedRequests.requestId | string |
data/attachedRequests/requestId |
|
attachedTasks
|
attachedTasks | array of object |
attachedTasks |
|
spaceId
|
attachedTasks.spaceId | string |
data/attachedTasks/spaceId |
|
taskId
|
attachedTasks.taskId | string |
data/attachedTasks/taskId |
|
managerId
|
managerId | string |
dados/managerId |
|
isTemplate
|
isTemplate | boolean |
dados/isTemplate |
|
atualizadoem
|
updatedAt | date-time |
dados/atualizadosEm |
|
actualDuration
|
actualDuration | integer |
data/actualDuration |
|
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
|
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
|
copyDe
|
copyFrom | string |
dados/cópiaDe |
|
seguidores
|
followers | array of object |
seguidores |
|
userId
|
followers.userId | string |
userId |
|
spaceId
|
spaceId | string |
dados/spaceId |
|
templateId
|
templateId | string |
dados/templateId |
|
updateDiffs
|
updateDiffs | array of object | |
|
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/antes |
|
after
|
updateDiffs.after | string |
data/updateDiffs/depois |
|
Configuração analítica
|
analyticSetting | ProgramAnalyticSetting | |
|
customProperties
|
customProperties | array of object | |
|
id
|
customProperties.id | string |
dados/customProperties/id |
|
valor múltiplo
|
customProperties.multipleValue | boolean |
dados/customProperties/multipleValue |
|
nome
|
customProperties.name | string |
dados/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object | |
|
id
|
customProperties.customProperties.id | string |
dados/customProperties/customProperties/id |
|
valor
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
tipo
|
customProperties.customProperties.type | string |
dados/customProperties/customProperties/type |
Solicitação de programa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do cessionário
|
assigneeId | string |
ID de utilizador do cessionário |
|
ID do cedente
|
assignerId | string |
ID de utilizador do cedente |
|
Associações
|
associations | array of Association |
Lista de associações (Conteúdo da biblioteca) |
|
Objetos de referência de conteúdo
|
contentRefs | array of ContentRef |
Lista de referências de conteúdo (conteúdo do WorkSpace e do DocCenter) |
|
Criado em
|
createdAt | date-time |
Cadeia de caracteres de data para a data de criação |
|
ID do criador
|
creatorId | string |
ID de utilizador do criador |
|
Propriedades personalizadas
|
customProperties | array of CustomPropertyValues |
Lista de propriedades personalizadas |
|
Followers
|
followers | array of Follower |
Lista de seguidores |
|
Formulário Ref
|
formRef |
Objeto de referência de formulário |
|
|
ID de solicitação
|
id | string | |
|
Observação
|
note | string |
Nota para notificações sobre alterações de estado |
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data da data de término planejada |
|
Data de início planeada
|
plannedStartDate | date-time |
Cadeia de caracteres de data da data de início planejada |
|
Priority
|
priority | string |
Valor prioritário |
|
ID do programa
|
programId | string |
ID do programa ao qual a solicitação está associada |
|
Classificação
|
rank | string |
Classificação do pedido na lista de pedidos |
|
requestFormCustomPropertyOption
|
requestFormCustomPropertyOption | RequestFormCustomProperties |
Solicitar propriedades personalizadas do formulário |
|
ID do espaço
|
spaceId | string | |
|
ID do esquema de status
|
statusSchemaId | string | |
|
ID do passo
|
stepId | integer |
ID da etapa indicando o valor de status |
|
Title
|
title | string |
Título do pedido |
|
Atualizado em
|
updatedAt | date-time |
Data da última atualização do pedido |
ProgramRequestQueryResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de registos devolvidos |
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
Objetos de solicitação
|
items | array of ProgramRequest |
Lista de objetos de solicitação na resposta |
|
Limite
|
limit | integer |
Número para limitar registos |
|
Objeto de metadados
|
meta | Meta |
Objeto de metadados |
PlannerSubTask
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Duração real
|
actualDuration | integer |
Duração real calculada em dias |
|
Data de Fim Real
|
actualEndDate | date-time |
Data em que o trabalho na tarefa foi concluído |
|
Data de início real
|
actualStartDate | date-time |
Data de início do trabalho na tarefa |
|
ID do cessionário
|
assigneeId | string |
ID de utilizador do cessionário |
|
ID do cedente
|
assignerId | string |
ID de utilizador do último utilizador a adicionar um cessionário |
|
Associações
|
associations | array of Association |
Lista de associações em uma tarefa |
|
Copiar de
|
copyFrom | string |
ID da tarefa da qual a tarefa foi copiada |
|
Criado em
|
createdAt | date-time |
Data de criação da tarefa |
|
ID do criador
|
creatorId | string |
ID de utilizador do criador |
|
Propriedades personalizadas
|
customProperties | array of CustomPropertyValues |
Lista de propriedades personalizadas em uma tarefa |
|
Description
|
description | string |
Descrição da tarefa |
|
Followers
|
followers | array of Follower |
Lista de seguidores em uma tarefa |
|
ID da tarefa
|
id | string | |
|
É modelo
|
isTemplate | boolean |
Indica se uma tarefa faz parte de um modelo |
|
Classificação máxima
|
maxRank | string |
Classificação máxima |
|
Classificação mínima
|
minRank | string |
Classificação mínima |
|
ID do pai
|
parentId | string |
ID da tarefa pai se a tarefa for uma subtarefa |
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Cadeia de caracteres de data de término (data de vencimento) |
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data de início |
|
Priority
|
priority | string |
Valor prioritário |
|
ID do programa
|
programId | string |
ID do programa ao qual a tarefa pertence |
|
Classificação
|
rank | string |
Classificação da tarefa em uma lista de tarefas |
|
ID do espaço
|
spaceId | string | |
|
ID do esquema de status
|
statusSchemaId | string | |
|
ID do passo
|
stepId | integer |
Id da etapa no esquema de status |
|
ID do modelo
|
templateId | string |
ID do modelo ao qual a tarefa pertence |
|
Title
|
title | string |
Título da tarefa |
|
Tipo
|
type | string |
Tipo de tarefa |
|
Atualizar em
|
updatedAt | date-time |
Data da última atualização da tarefa |
ProgramTask
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Duração real
|
actualDuration | integer |
Duração real calculada em dias |
|
Data de Fim Real
|
actualEndDate | date-time |
Data em que o trabalho na tarefa foi concluído |
|
Data de início real
|
actualStartDate | date-time |
Data de início do trabalho na tarefa |
|
ID do Atribuinte
|
assigneeId | string |
ID de utilizador do cessionário |
|
ID do cedente
|
assignerId | string |
ID de utilizador do último utilizador a adicionar um cessionário |
|
Associações
|
associations | array of Association |
Lista de associações em uma tarefa |
|
Copiar de
|
copyFrom | string |
ID da tarefa da qual a tarefa foi copiada |
|
Criado em
|
createdAt | date-time |
Data de criação da tarefa |
|
ID do criador
|
creatorId | string |
ID de utilizador do criador |
|
Propriedades personalizadas
|
customProperties | array of CustomPropertyValues |
Lista de propriedades personalizadas em uma tarefa |
|
Description
|
description | string |
Descrição da tarefa |
|
Followers
|
followers | array of Follower |
Lista de seguidores em uma tarefa |
|
ID da tarefa
|
id | string | |
|
É modelo
|
isTemplate | boolean |
Indica se uma tarefa faz parte de um modelo |
|
Classificação máxima
|
maxRank | string |
Classificação máxima |
|
Classificação mínima
|
minRank | string |
Classificação mínima |
|
ID do pai
|
parentId | string |
ID da tarefa pai se a tarefa for uma subtarefa |
|
Duração prevista
|
plannedDuration | integer |
Duração prevista em dias |
|
Data de Fim Prevista
|
plannedEndDate | date-time |
Sequência de datas da data de término planejada (data de vencimento) |
|
Data de início prevista
|
plannedStartDate | date-time |
Cadeia de caracteres de data da data de início planejada |
|
Priority
|
priority | string |
Valor prioritário |
|
ID do programa
|
programId | string |
ID do programa ao qual a tarefa pertence |
|
Classificação
|
rank | string |
Classificação da tarefa em uma lista de tarefas |
|
ID do espaço
|
spaceId | string | |
|
ID do esquema de status
|
statusSchemaId | string | |
|
ID do passo
|
stepId | integer |
Id da etapa no esquema de status |
|
IDs de subtarefas
|
subTaskIds | array of string |
Lista de IDs de subtarefas |
|
Subtarefas
|
subTasks | array of PlannerSubTask |
Lista de subtarefas na tarefa |
|
ID do modelo
|
templateId | string |
ID do modelo ao qual a tarefa pertence |
|
Title
|
title | string |
Título da tarefa |
|
Tipo
|
type | string |
Tipo de tarefa |
|
Atualizado em
|
updatedAt | date-time |
Data da última atualização da tarefa |
ProgramTaskQueryResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de registos devolvidos |
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
Objetos de tarefa
|
items | array of ProgramTask |
Lista de objetos de tarefa na resposta |
|
Limite
|
limit | integer |
Número para limitar registos |
|
Objeto de metadados
|
meta | Meta |
Objeto de metadados |
PossibleValuesItem
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do valor
|
id | string | |
|
Encomenda
|
order | integer |
Número para indicar a ordem |
|
Valor
|
value |
Dados de valor real |
ProgramAssociatedNodes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do nó
|
nodeId | string | |
|
Tipo de nó
|
nodeType | string |
Tipo de nó da associação |
|
ID do espaço
|
spaceId | string |
RequestFormCustomProperties
Solicitar propriedades personalizadas do formulário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | date-time |
Cadeia de caracteres de data de criação |
|
Propriedades personalizadas
|
customProperties | array of CustomProperty |
Lista de propriedades personalizadas |
RequestWebhookResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
dados/id |
|
tenantId
|
tenantId | string |
dados/tenantId |
|
Nome do locatário
|
tenantName | string |
nome_dados/inquilino |
|
requestId
|
requestId | string |
dados/requestId |
|
eventTimestamp
|
eventTimestamp | integer |
data/eventTimestamp |
|
actorId
|
actorId | string |
dados/actorId |
|
spaceId
|
spaceId | string |
dados/spaceId |
|
title
|
title | string |
dados/título |
|
assigneeId
|
assigneeId | string |
dados/cessionárioId |
|
assignerId
|
assignerId | string |
data/assignerId |
|
criadorId
|
creatorId | string |
dados/creatorId |
|
planejadoStartDate
|
plannedStartDate | date-time |
data/planejadoStartDate |
|
planejadoEndDate
|
plannedEndDate | date-time |
data/planejadoEndDate |
|
planeadoDuração
|
plannedDuration | integer |
dados/planeadoDuração |
|
criadosAt
|
createdAt | date-time |
dados/criadosAt |
|
atualizadoem
|
updatedAt | date-time |
dados/atualizadosEm |
|
estado
|
status | string |
dados/estado |
|
priority
|
priority | string |
dados/prioridade |
|
Id do programa
|
programId | string |
dados/programId |
|
Observação
|
note | string |
dados/nota |
|
formId
|
formRef.formId | string |
dados/formRef/formId |
|
versão menor
|
formRef.minorVersion | integer |
data/formRef/minorVersion |
|
majorVersão
|
formRef.majorVersion | integer |
data/formRef/majorVersion |
|
seguidores
|
followers | array of object |
seguidores |
|
userId
|
followers.userId | string |
userId |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
updateDiffs
|
updateDiffs | array of object |
data/updateDiffs |
|
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/antes |
|
after
|
updateDiffs.after | string |
data/updateDiffs/depois |
|
customProperties
|
customProperties | array of object |
dados |
|
id
|
customProperties.id | string |
dados/customProperties/id |
|
valor múltiplo
|
customProperties.multipleValue | boolean |
dados/customProperties/multipleValue |
|
nome
|
customProperties.name | string |
dados/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object |
customProperties |
|
id
|
customProperties.customProperties.id | string |
dados/customProperties/customProperties/id |
|
valor
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
tipo
|
customProperties.customProperties.type | string |
dados/customProperties/customProperties/type |
ScopeSettingsItemDefinition
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
é obrigatório
|
isRequired | boolean |
Indicador sobre se um campo é obrigatório ou não |
|
Scope
|
scope | string |
Lista de tipos de nó aos quais a definição de propriedade personalizada pertence |
StatusSchema
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
createdAt | date-time |
Cadeia de caracteres de data de criação |
|
ID do criador
|
creatorId | string |
ID de utilizador do criador |
|
ID do esquema de status
|
id | string | |
|
É padrão
|
isDefault | boolean |
Indicador sobre se o esquema de status é o esquema padrão |
|
Nome
|
name | string |
Nome do esquema de status |
|
ID do espaço
|
spaceId | string | |
|
Steps
|
steps | array of string |
Lista de etapas e seus valores |
|
Transições
|
transitions | array of array |
Lista de regras de transição |
|
items
|
transitions | array of integer | |
|
Tipo
|
type | string |
Tipo de nó para o qual o esquema de status pode ser usado |
|
Atualizado em
|
updatedAt | date-time |
Data da última atualização do esquema de status |
StatusSchemaQueryResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de registos devolvidos |
|
Cursor
|
cursor | string |
Cursor usado para paginação |
|
Objetos do esquema de status
|
items | array of StatusSchema |
Lista de objetos de esquema de status na resposta |
|
Limite
|
limit | integer |
Número para limitar registos |
|
Objeto de metadados
|
meta | Meta |
Objeto de metadados |
TaskWebhookResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
dados/id |
|
tenantId
|
tenantId | string |
dados/tenantId |
|
Nome do locatário
|
tenantName | string |
nome_dados/inquilino |
|
taskId
|
taskId | string |
dados/taskId |
|
eventTimestamp
|
eventTimestamp | integer |
data/eventTimestamp |
|
actorId
|
actorId | string |
dados/actorId |
|
spaceId
|
spaceId | string |
dados/spaceId |
|
title
|
title | string |
dados/título |
|
descrição
|
description | string |
dados/descrição |
|
assigneeId
|
assigneeId | string |
dados/cessionárioId |
|
assignerId
|
assignerId | string |
data/assignerId |
|
criadorId
|
creatorId | string |
dados/creatorId |
|
planejadoStartDate
|
plannedStartDate | date-time |
data/planejadoStartDate |
|
planejadoEndDate
|
plannedEndDate | date-time |
data/planejadoEndDate |
|
planeadoDuração
|
plannedDuration | integer |
dados/planeadoDuração |
|
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
|
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
|
actualDuration
|
actualDuration | integer |
data/actualDuration |
|
criadosAt
|
createdAt | date-time |
dados/criadosAt |
|
atualizadoem
|
updatedAt | date-time |
dados/atualizadosEm |
|
estado
|
status | string |
dados/estado |
|
priority
|
priority | string |
dados/prioridade |
|
parentId
|
parentId | string |
dados/parentId |
|
Id do programa
|
programId | string |
dados/programId |
|
copyDe
|
copyFrom | string |
dados/cópiaDe |
|
seguidores
|
followers | array of object |
seguidores |
|
userId
|
followers.userId | string |
userId |
|
templateId
|
templateId | string |
dados/templateId |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
attachedSubTasks
|
attachedSubTasks | array of object |
attachedSubTasks |
|
spaceId
|
attachedSubTasks.spaceId | string |
data/attachedSubTasks/spaceId |
|
taskId
|
attachedSubTasks.taskId | string |
data/attachedSubTasks/taskId |
|
updateDiffs
|
updateDiffs | array of object | |
|
fieldName
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/antes |
|
after
|
updateDiffs.after | string |
data/updateDiffs/depois |
|
customProperties
|
customProperties | array of object |
dados |
|
id
|
customProperties.id | string |
dados/customProperties/id |
|
valor múltiplo
|
customProperties.multipleValue | boolean |
dados/customProperties/multipleValue |
|
nome
|
customProperties.name | string |
dados/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object |
customProperties |
|
id
|
customProperties.customProperties.id | string |
dados/customProperties/customProperties/id |
|
valor
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
tipo
|
customProperties.customProperties.type | string |
dados/customProperties/customProperties/type |
ValueSchemaPropertyDefinition
Definição de esquema de valor
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número máximo
|
max | string | |
|
Número mínimo
|
min | string |