Compartilhar via


Programas sísmicos (versão prévia)

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. Isso inclui programas, que acompanham o progresso e as configurações do seu programa de habilitação contínuo; tarefas, a ferramenta de gerenciamento de trabalho que monitora as atividades da sua equipe; e solicitações, que permitem que membros externos da equipe enviem solicitações de trabalho para sua equipe.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Sísmico
URL https://seismic.com
Email support@seismic.com
Metadados do conector
Publicador Software Sísmico
Site 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. Isso inclui programas, que acompanham o progresso e as configurações do seu programa de habilitação contínuo; tarefas, a ferramenta de gerenciamento de trabalho que monitora as atividades da sua equipe; e solicitações, que permitem que membros externos da equipe enviem solicitações de trabalho para sua equipe.

Publicador: Sísmico

Pré-requisitos

Você precisa de uma conta de usuário do Seismic Premium para o locatário.

Operações com suporte

Obter comentários

Obtenha uma lista de comentários em um único nó (programa, tarefa, solicitação).

Obter um comentário

Obtenha um único comentário em 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 sobre 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 solicitações

Obtenha uma lista de solicitações em um locatário.

Obter uma solicitação

Obtenha uma única solicitação em um locatário.

Criar uma solicitação

Crie uma solicitação em um locatário.

Atualizar uma solicitação

Atualize uma única solicitação em um locatário.

Excluir uma solicitação

Exclua uma única solicitação em um locatário.

Solicitações de exclusã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

Atualize uma única tarefa em um locatário.

Excluir 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 após a criação

Gatilho: quando um programa é atualizado

Um gatilho que usa o webhook ProgramUpdate para retornar dados do programa após a atualização

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 de tarefa depois que ele for atualizado

Gatilho: quando uma tarefa é excluída

Um gatilho que usa o webhook ProgramTaskDelete para retornar dados da tarefa depois que ele foi excluído

Gatilho: quando uma solicitação é criada

Um gatilho que usa o webhook ProgramRequestCreate para retornar dados de solicitação após a criação

Gatilho: quando uma solicitação é atualizada

Um gatilho que usa o webhook ProgramRequestUpdate para retornar dados de solicitação após a atualização

Gatilho: quando uma solicitação é excluída

Um gatilho que usa o webhook ProgramRequestDelete para retornar dados de solicitação após ele ter sido excluído

Obtendo credenciais

Você precisa de uma conta de usuário do Seismic Premium para o locatário. Entre em contato com o administrador do sistema Sísmico se você não tiver permissões suficientes.

Introdução

O conector de Programas Sísmicos inclui as ações a seguir. Cada ação corresponde a um ponto de extremidade de API. Consulte o artigo para cada ponto de extremidade de API correspondente para obter mais informações sobre os campos e as propriedades associadas à ação.

Problemas e limitações conhecidos

Nenhum problema e limitações são conhecidos no momento. Todas as APIs operam de acordo com a política de API Sísmica, incluindo limites de taxa. Consulte o portal do Seismic Developer para especificações, restrições e padrões da API.

Instruções de implantação

Use estas instruções para implantar esse conector como um conector personalizado no Microsoft Power Automate e no Power Apps.

Limitações

Nome Chamadas Período de renovação
Chamadas à 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 solicitação

Atualize uma solicitação.

Atualizar tarefa

Atualize uma tarefa existente.

Atualizar um programa

Atualize e retorne um programa.

Criar comentário

Crie um comentário em um determinado programa, tarefa ou solicitação. Requer a ID do nó (programa, tarefa ou solicitação).

Criar programa

Crie um programa.

Criar solicitação

Crie uma solicitação.

Criar tarefa

Crie uma tarefa.

Excluir comentário

Exclua 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 comentário

Obtenha um único comentário. Requer nó (programa, tarefa ou solicitação) e ID de comentário.

Obter comentários

Obtenha todos os comentários de um determinado programa, tarefa ou solicitação. Requer a ID do nó (programa, tarefa ou solicitação).

Obter esquema de status

Obtenha um único esquema de status por ID. Esses esquemas contêm os dados para definir status para um trabalho específico.

Exemplo: (Not started, In progress, Complete)

Obter esquemas de status

Obtenha uma lista de esquemas de status de tarefa/solicitação. Esses esquemas contêm os dados para definir status para um trabalho específico.

Exemplo: (Not started, In progress, Complete)

Obter programa

Obtenha um único programa por ID. Retornar tarefas, se desejado.

Obter programas

Obtenha uma lista de programas com seus atributos e associações.

Obter solicitações

Obtenha uma lista de solicitações.

Obter tarefa

Obtenha uma única tarefa por ID.

Obter tarefas

Obtenha uma lista de tarefas.

Solicitação GET

Obtenha uma única solicitação.

Solicitações de exclusão

Solicitações de exclusão em massa.

Atualizar comentário

Atualize um comentário existente. Requer nó (programa, tarefa ou solicitação) e ID de comentário.

Parâmetros

Nome Chave Obrigató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

Conteúdo de anotação
annotationPayload string
Tipo de anotação
annotationType string
Conteúdo do Comentário
commentContent True string

Conteúdo do comentário

É resolvido
isResolved boolean

True/false sobre se o comentário foi resolvido

Retornos

Corpo
Comment

Atualizar solicitação

Atualize uma solicitação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID da Solicitação
requestId True string

ID da Solicitação

ID do atribuídor
assigneeId string

ID do usuário do destinatário

ID de conteúdo
contentId uuid

ID de 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 de versão principal

Versão Menor
minorVersion integer

Número de versão secundária

Data modificada
modifiedDate date-time

Data em que a referência de conteúdo foi atualizada pela última vez

Número do Pedido
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 de versão do perfil

Source
source string

Fonte de conteúdo

TeamSite ID
teamSiteId string

TeamSite ID

ID da miniatura
thumbnailId string

ID da miniatura de imagem

ID da versão
versionId uuid

ID de versão do conteúdo

ID da propriedade personalizada
id string
ID do valor
id string
Value
value

Dados de valor para o valor da propriedade personalizada

Referência de formulário
formRef True

Objeto de referência de formulário

Observação
note string

Observação usada para notificações sobre alterações de status

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término planejada (data de conclusão)

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início planejada

Priority
priority string

Valor de prioridade

ID do programa
programId string

ID do programa ao qual a solicitação pertence

ID da etapa
stepId True integer

ID da etapa que indica o status

Title
title True string

Título da solicitação

Retornos

Atualizar tarefa

Atualize uma tarefa existente.

Parâmetros

Nome Chave Obrigató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 atribuídor
assigneeId string

ID do usuário do destinatário

ID da propriedade personalizada
id string
ID do valor
id string
Value
value

Dados de valor para o valor da propriedade personalizada

Description
description string

Descrição da tarefa

ID Principal
parentId string

ID da tarefa pai

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término planejada

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início planejada

Priority
priority string

Valor de prioridade

ID do programa
programId string

ID do programa à qual a tarefa pertence

ID da etapa
stepId integer

ID da etapa que indica o status da tarefa

Title
title True string

Título da tarefa

Retornos

Corpo
ProgramTask

Atualizar um programa

Atualize e retorne um programa.

Parâmetros

Nome Chave Obrigató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 da fase que vem de PhaseType

Arquivados
archived boolean

Indicador sobre se um programa está arquivado ou não

Enabled
enabled boolean

Indicador preterido para arquivo morto

Ocultar Dicas
hideTips boolean

Indicador se o usuário tem dicas ocultas ou não

Data de inicialização
launchDate date-time

Data de inicialização

Tipo
type string

Tipo de objeto de audiência

ID
id string

ID da audiência (grupo de usuários, usuário etc.)

Controladores
trackers array of string

Lista de rastreadores de palavras-chave

Tópicos
topics array of string

Lista de tópicos de palavra-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

Métrica de KPI de segundo resultado
outcomeKpiSecond string

Métrica de KPI de segundo resultado

Métrica de KPI de terceiro resultado
outcomeKpiThird string

Métrica de KPI de terceiro resultado

Tipo de métrica
metricType string

Tipo de métrica

Valor-alvo
targetValue string

Valor de destino de número especificado pelo usuário para objetivo

Medido em
measuredIn string

Opção para definir como a métrica é medida

Trend
trend string

Opção para definir como a tendência de objetivo está sendo controlada

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 da métrica 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 da 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
Value
value

Dados de valor para o valor da propriedade personalizada

Description
description string

Descrição do programa

Está ativo
isActive boolean

Indicador sobre se um programa está ativo?

ID do gerente
managerId string

ID do usuário do gerenciador de programas

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término planejada

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início planejada

Title
title True string

Título do programa

Retornos

Corpo
Program

Criar comentário

Crie um comentário em um determinado programa, tarefa ou solicitação. Requer a ID do nó (programa, tarefa ou solicitação).

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID do nó
nodeId True string

ID do nó

Conteúdo 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

É resolvido
isResolved boolean

True/false sobre se o comentário foi resolvido

Retornos

Corpo
Comment

Criar programa

Crie um programa.

Parâmetros

Nome Chave Obrigató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 da propriedade personalizada
id string
ID do valor
id string
Value
value

Dados de valor para o valor da propriedade personalizada

Description
description string

Título da descrição

ID do gerente
managerId string

ID do usuário do gerenciador

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início

Title
title True string

Título do programa

Retornos

Corpo
Program

Criar solicitação

Crie uma solicitação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID do atribuídor
assigneeId string

ID do usuário do atribuídor

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 conteúdo
contentId uuid

ID de 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 de versão principal

Versão Menor
minorVersion integer

Número de versão secundária

Data modificada
modifiedDate date-time

Data em que a referência de conteúdo foi atualizada pela última vez

Número do Pedido
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 de versão do perfil

Source
source string

Fonte de conteúdo

TeamSite ID
teamSiteId string

TeamSite ID

ID da miniatura
thumbnailId string

ID da miniatura de imagem

ID da versão
versionId uuid

ID de versão do conteúdo

ID da propriedade personalizada
id string
ID do valor
id string
Value
value

Dados de valor para o valor da propriedade personalizada

Referência de formulário
formRef True

Objeto de referência de formulário

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início

Priority
priority string

Valor de prioridade

ID do programa
programId string

ID do programa ao qual a solicitação pertence

ID do esquema de status
statusSchemaId string
Title
title True string

Título da solicitação

Retornos

Criar tarefa

Crie uma tarefa.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID do atribuídor
assigneeId string

ID do usuário do atribuídor

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 da propriedade personalizada
id string
ID do valor
id string
Value
value

Dados de valor para o valor da propriedade personalizada

Description
description string

Descrição da tarefa

ID Principal
parentId string

ID da tarefa do pai

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da 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

Retornos

Corpo
ProgramTask

Excluir comentário

Exclua um comentário. Requer nó (programa, tarefa ou solicitação) e ID de comentário.

Parâmetros

Nome Chave Obrigató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

Nome Chave Obrigató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

Exclua também as tarefas associadas

Retornos

Excluir programas

Exclua um ou mais programas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

IDs do programa
ids True array

Lista de IDs do programa

Excluir Tarefas
deleteTasks boolean

Exclua também as tarefas associadas

Retornos

Excluir solicitação

Excluir uma solicitação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID da Solicitação
requestId True string

ID da Solicitação

Excluir tarefa

Excluir uma tarefa.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID da Tarefa
taskId True string

ID da Tarefa

Retornos

Obter comentário

Obtenha um único comentário. Requer nó (programa, tarefa ou solicitação) e ID de comentário.

Parâmetros

Nome Chave Obrigató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

Retornos

Corpo
Comment

Obter comentários

Obtenha todos os comentários de um determinado programa, tarefa ou solicitação. Requer a ID do nó (programa, tarefa ou solicitação).

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID do nó
nodeId True string

ID do nó

IDs do criador
creatorIds array

Lista de IDs de usuário a serem consultadas pelo criador

Cursor
cursor string

Cursor usado para paginação

Limit
limit integer

Número para limitar registros

Classificar
sort array

Classificar por consulta

Retornos

Obter esquema de status

Obtenha um único esquema de status por ID. Esses esquemas contêm os dados para definir status para um trabalho específico.

Exemplo: (Not started, In progress, Complete)

Parâmetros

Nome Chave Obrigató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

Retornos

Corpo
StatusSchema

Obter esquemas de status

Obtenha uma lista de esquemas de status de tarefa/solicitação. Esses esquemas contêm os dados para definir status para um trabalho específico.

Exemplo: (Not started, In progress, Complete)

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

É Padrão
isDefault boolean

Obter o esquema de status padrão

Tipo
type string

Consulta por tipo de nó

IDs de esquema de status
ids array

Lista de IDs de esquemas de status

IDs do criador
creatorIds array

Lista de IDs de usuário a serem consultadas pelo criador

Cursor
cursor string

Cursor usado para paginação

Limit
limit integer

Número para limitar registros retornados

Retornos

Obter programa

Obtenha um único programa por ID. Retornar tarefas, se desejado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID do programa
programId True string

ID do programa

Profundidade de nós associados
associatedNodesDepth integer

Número para indicar a profundidade dos dados de nó associados retornados

Incluir Trabalhos
includeWorks boolean

Indicador para incluir dados de tarefas associadas

Retornos

Corpo
Program

Obter programas

Obtenha uma lista de programas com seus atributos e associações.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

Data de término planejada de
plannedEndDateFrom date-time

Filtrar 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 planejada de
plannedStartDateFrom date-time

Filtrar de uma data de início planejada

Data de início planejada para
plannedStartDateTo date-time

Filtrar para uma data de início planejada

Data de inicialização de
launchDateFrom date-time

Filtrar de uma data de inicialização

Data de inicialização para
launchDateTo date-time

Filtrar para uma data de inicialização

IDs do programa
ids array

Lista de IDs do programa a serem consultadas por

Título do programa
title string

Título do programa a ser consultado por

IDs do gerente
managerIds array

Lista de IDs de usuário a serem consultadas pelo gerente

IDs do criador
creatorIds array

Lista de IDs de usuário a serem consultadas pelo criador

IDs de nó associadas
associatedNodeIds array

Lista de IDs de associação a serem consultadas por

Cursor
cursor string

Cursor usado para paginação

Limit
limit integer

Número para limitar registros retornados

Classificar
sort array

Classificar consulta

Propriedades personalizadas
customProperties string

Lista de propriedades personalizadas a serem consultadas por

IDs do seguidor
followerIds array

Lista de IDs de usuário a serem consultadas por seguidor

Arquivados
archived boolean

Lista de programas arquivados ou não arquivados

Público
audience array

Lista de IDs de usuário do público-alvo do programa a serem consultadas por

Tipo de programa
programType string

ProgramType enumerar por

Primeira métrica de KPI de resultado
outcomeKpiFirst string

Primeira enumeração de métrica de KPI de resultado a ser consultada por

Métrica de KPI de segundo resultado
outcomeKpiSecond string

Enumeração de métrica de KPI de segundo resultado a ser consultada por

Métrica de KPI de terceiro resultado
outcomeKpiThird string

Enumeração de métrica de KPI de terceiro resultado a ser consultada por

Fases atuais
currentPhases array

Uma lista de IDs de fase atuais a serem consultadas 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 (ignorados quando habilitados são passados)

Incluir Páginas
includePages boolean

Indicador para permitir a inclusão de dados de páginas

Retornos

Obter solicitações

Obtenha uma lista de solicitações.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

Data de término planejada de
plannedEndDateFrom date-time

filtrar por data de conclusão da solicitação (inclusive)

Data de término planejada para
plannedEndDateTo date-time

filtrar por data de conclusão da solicitação (exclusiva)

Data de início planejada de
plannedStartDateFrom date-time

filtrar por data de início da solicitação (inclusive)

Data de início planejada para
plannedStartDateTo date-time

filtrar por data de início da solicitação (exclusiva)

Criado a partir de
createdAtFrom date-time

filtrar por data criada pela solicitação (inclusive)

Criado em
createdAtTo date-time

filtrar por data criada pela solicitação (exclusiva)

Atualizado em De
updatedAtFrom date-time

filtrar por data atualizada da solicitação (inclusive)

Atualizado em Para
updatedAtTo date-time

filtrar por data atualizada da solicitação (exclusiva)

IDs de solicitação
ids array

Uma lista de IDs de solicitação

Title
title string

Valores de palavra-chave a serem pesquisados em títulos de solicitação

IDs do atribuídor
assigneeIds array

Uma lista de IDs de usuário dos atribuidores a serem filtradas 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 palavra-chave a serem pesquisados

IDs do atribuídor
assignerIds array

Uma lista de IDs de usuário do atribuídor a serem filtradas por

IDs do criador
creatorIds array

Uma lista de IDs de usuário dos criadores a serem filtradas por

IDs da etapa
stepIds array

Uma lista de IDs de etapa a serem filtradas por

ID do esquema de status
statusSchemaId string

ID do esquema de status a ser filtrada por

Cursor
cursor string

Um token usado para orientar a janela da próxima página

Limit
limit integer

Número de itens a serem retornados por página, padrão: 50

Classificar
sort array

Classificar por solicitações

ID do programa
programId string

A ID do programa à qual uma solicitação está associada

Tem Programa
hasProgram boolean

Filtrar se as solicitações estiverem associadas a um programa

Propriedades personalizadas
customProperties string

Filtrar por propriedades personalizadas

IDs do seguidor
followerIds array

Uma lista da ID de usuário dos seguidores

IDs de nó associadas
associatedNodeIds array

Uma lista de IDs de nó associadas a serem filtradas 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 deve incluir propriedades personalizadas do formulário de solicitação, false padrão

Retornos

Obter tarefa

Obtenha uma única tarefa por ID.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID da Tarefa
taskId True string

ID da Tarefa

Retornos

Corpo
ProgramTask

Obter tarefas

Obtenha uma lista de tarefas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

Data de término planejada 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 (exclusiva)

Data de início planejada de
plannedStartDateFrom date-time

Filtrar por data de início da tarefa (inclusive)

Data de início planejada para
plannedStartDateTo date-time

Filtrar por data de início da tarefa (exclusiva)

Criado a partir de
createdAtFrom date-time

Filtrar por data criada pela tarefa (inclusive)

Criado em
createdAtTo date-time

Filtrar por data criada pela tarefa (exclusiva)

Atualizado em De
updatedAtFrom date-time

Filtrar por data atualizada da tarefa (inclusive)

Atualizado em Para
updatedAtTo date-time

Filtrar por data atualizada da tarefa (exclusiva)

IDs de tarefa
ids array

Filtrar por uma lista de IDs de tarefa

Title
title string

Filtrar por título da tarefa

Description
description string

Filtrar por descrição da tarefa

IDs do atribuídor
assigneeIds array

Lista de IDs de usuário a serem filtradas pelo atribuídor

Prioridades
priorities array

Filtrar por lista de prioridades

Palavras-chave
keywords string

Filtrar por palavras-chave

IDs do atribuídor
assignerIds array

Lista de IDs de usuário a serem filtradas pelo usuário que atribuiu a tarefa

IDs da 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

Limit
limit integer

Número para limitar registros retornados

Classificar
sort array

Classificar 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 do seguidor
followerIds array

Lista de IDs de usuário a serem filtradas por seguidores

IDs de nó associadas
associatedNodeIds array

Lista de IDs de associação a serem filtradas por

IDs do criador
creatorIds array

Lista de IDs de usuário a serem filtradas pelo criador

Incluir Associações
includeAssociations boolean

Incluir dados de associação na resposta

ID Principal
parentId string

Lista de IDs de tarefa a serem filtradas por

Retornos

Solicitação GET

Obtenha uma única solicitação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do espaço
spaceId True string

ID do espaço

ID da Solicitação
requestId True string

ID da Solicitação

Retornos

Solicitações de exclusão

Solicitações de exclusão em massa.

Parâmetros

Nome Chave Obrigató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

Retornos

Gatilhos

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 é atualizada

Gatilho para responder quando uma solicitação é atualizada

Quando uma solicitação é criada

Gatilho para responder quando uma solicitação é criada

Quando uma solicitação é excluída

Gatilho para responder quando uma solicitação é excluída

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 é excluída

Gatilho para responder quando uma tarefa é excluída

Quando um programa é atualizado

Gatilho para responder quando um programa é atualizado

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data ProgramWebhookResponse

dados

Quando um programa é criado

Gatilho para responder quando um programa é criado

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data ProgramWebhookResponse

dados

Quando um programa é excluído

Gatilho para responder quando um programa é excluído

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data ProgramWebhookResponse

dados

Quando uma solicitação é atualizada

Gatilho para responder quando uma solicitação é atualizada

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data RequestWebhookResponse

Quando uma solicitação é criada

Gatilho para responder quando uma solicitação é criada

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data RequestWebhookResponse

Quando uma solicitação é excluída

Gatilho para responder quando uma solicitação é excluída

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data RequestWebhookResponse

Quando uma tarefa é atualizada

Gatilho para responder quando uma tarefa é atualizada

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data TaskWebhookResponse

Quando uma tarefa é criada

Gatilho para responder quando uma tarefa é criada

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data TaskWebhookResponse

Quando uma tarefa é excluída

Gatilho para responder quando uma tarefa é excluída

Parâmetros

Nome Chave Obrigató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 detalhes.

Retornos

Nome Caminho Tipo Description
id
id uuid

Um identificador exclusivo para o evento.

versão
version string

A versão do evento, por exemplo, "ProgramCreateV1".

occurredAt
occurredAt date-time

Carimbo de data/hora ISO 8601 quando o evento ocorreu em UTC.

tenantId
tenantId uuid

Identificador exclusivo para o locatário.

tenantName
tenantName string

Nome do locatário.

aplicação
application string

O aplicativo de origem do evento.

productArea
productArea string

A área do produto relacionada ao evento.

dados
data TaskWebhookResponse

Definições

Associação

Nome 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

Nome Caminho Tipo Description
IDs de operação assíncrona
asyncOperationIds array of string

Lista de IDs de ação assíncrona

Público

Objeto Audience

Nome Caminho Tipo Description
Tipo
type string

Tipo de objeto de audiência

ID
id string

ID da audiência (grupo de usuários, usuário etc.)

Comment

Nome Caminho Tipo Description
Conteúdo 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 da data criada

ID do Criador
creatorId string

ID do usuário do criador

ID do comentário
id string

ID do comentário

É resolvido
isResolved boolean

True/false 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 de Página
pageIndex string

Índice de página de número

ID Principal
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

Cadeia de caracteres de data da data atualizada

CommentQueryResponse

Nome Caminho Tipo Description
Contagem
count integer

Número de registros retornados

Cursor
cursor string

Cursor usado para paginação

Itens
items array of Comment

Lista de itens na resposta

Limit
limit integer

Número para limitar registros

Objeto de metadados
meta Meta

Objeto de metadados

ContentRef

Nome Caminho Tipo Description
ID de conteúdo
contentId uuid

ID de 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 de versão principal

Versão Menor
minorVersion integer

Número de versão secundária

Data modificada
modifiedDate date-time

Data em que a referência de conteúdo foi atualizada pela última vez

Número do Pedido
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 de versão do perfil

Source
source string

Fonte de conteúdo

TeamSite ID
teamSiteId string

TeamSite ID

ID da miniatura
thumbnailId string

ID da miniatura de imagem

ID da versão
versionId uuid

ID de versão do conteúdo

CustomProperty

Nome Caminho Tipo Description
Permitir vários valores
allowMultipleValues boolean

Indica se a propriedade personalizada permite vários valores

Criado por ID
createdById string

ID do usuário 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 da propriedade personalizada
id string
É necessário
isRequired boolean

Indica se a propriedade personalizada é necessária ou não

Última modificação por ID
lastModifiedById string

ID 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 as configurações para operações diferentes em uma propriedade personalizada

Pedido
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 as configurações para escopos diferentes em uma propriedade personalizada

Escopos
scopes array of string

Lista de escopos

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 de propriedade personalizado

CustomPropertyValues

Nome Caminho Tipo Description
ID da 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

Nome Caminho Tipo Description
ID do valor
id string
Value
value

Dados de valor para o valor da propriedade personalizada

Seguidor

Nome Caminho Tipo Description
ID do grupo usuário/usuário
id string

ID do usuário/grupo de usuários do seguidor

Tipo
type string

Tipo de seguidor de grupo de usuários ou usuários

Meta

Objeto de metadados

Nome Caminho Tipo Description
Contagem
count integer

Número de registros retornados

Query
query array of MetaQueryInfo

Objeto de consulta

MetaQueryInfo

Nome Caminho Tipo Description
Classificar
sort array of string

Classificar consulta

MetricObjective

Objeto de objetivo de métrica

Nome Caminho Tipo Description
Tipo de métrica
metricType string

Tipo de métrica

Valor-alvo
targetValue string

Valor de destino de número especificado pelo usuário para objetivo

Medido em
measuredIn string

Opção para definir como a métrica é medida

Trend
trend string

Opção para definir como a tendência de objetivo está sendo controlada

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 da métrica da página de visão geral

Phase

Fase do programa

Nome 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 da fase que vem de PhaseType

Programa

Nome Caminho Tipo Description
Duração real
actualDuration integer

Duração real calculada em dias

Data de término real
actualEndDate date-time

Data de término calculada de quando o programa realmente terminou

Data de início real
actualStartDate date-time

Data de início calculada 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

Associations
associations array of Association

Lista de associações (conteúdo da biblioteca)

Copiar de
copyFrom string

ID do programa da qual o programa é copiado

Criado em
createdAt date-time

Cadeia de caracteres de data da data criada

ID do Criador
creatorId string

ID do usuário do criador

Propriedades personalizadas
customProperties array of CustomPropertyValues

Lista de propriedades personalizadas

Breve Descrição
description string

Breve descrição do programa

Seguidores
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 gerente
managerId string

ID do usuário do gerenciador de programas

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 Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término planejada

Data de início planejada
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 da qual o programa foi criado

Title
title string

Título do programa

Atualizado em
updatedAt date-time

O programa date foi atualizado pela última vez

Obras
works array of ProgramTask

Lista de tarefas e solicitações

ProgramAnalyticSetting

Nome Caminho Tipo Description
Phase
currentPhase Phase

Fase do programa

Fases
phases array of Phase

Lista de possíveis fases do programa

Arquivados
archived boolean

Indicador sobre se um programa está arquivado ou não

Enabled
enabled boolean

Indicador preterido para arquivo morto

Ocultar Dicas
hideTips boolean

Indicador se o usuário tem dicas ocultas ou não

Data de inicialização
launchDate date-time

Data de inicialização

Público
audience array of Audience

Lista de grupos de usuários para o público-alvo do programa

Controladores
trackers array of string

Lista de rastreadores de palavras-chave

Tópicos
topics array of string

Lista de tópicos de palavra-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

Métrica de KPI de segundo resultado
outcomeKpiSecond string

Métrica de KPI de segundo resultado

Métrica de KPI de terceiro resultado
outcomeKpiThird string

Métrica de KPI de terceiro resultado

Objetivos de Métrica
metricObjectives array of MetricObjective

Lista de objetivos de métrica

ProgramQueryResponse

Nome Caminho Tipo Description
Contagem
count integer

Número de registros retornados

Cursor
cursor string

Cursor usado para paginação

Objetos de programa
items array of Program

Lista de itens de programa na resposta

Limit
limit integer

Número para limitar registros

Objeto de metadados
meta Meta

Objeto de metadados

ProgramWebhookResponse

dados

Nome Caminho Tipo Description
tenantId
tenantId string

data/tenantId

tenantName
tenantName string

data/tenantName

actorId
actorId string

data/actorId

eventTimestamp
eventTimestamp integer

data/eventTimestamp

programId
programId string

data/programId

title
title string

data/title

descrição
description string

dados/descrição

plannedStartDate
plannedStartDate date-time

data/plannedStartDate

plannedEndDate
plannedEndDate date-time

data/plannedEndDate

plannedDuration
plannedDuration integer

data/plannedDuration

creatorId
creatorId string

data/creatorId

createdAt
createdAt date-time

data/createdAt

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

data/managerId

isTemplate
isTemplate boolean

data/isTemplate

updatedAt
updatedAt date-time

data/updatedAt

actualDuration
actualDuration integer

data/actualDuration

actualStartDate
actualStartDate date-time

data/actualStartDate

actualEndDate
actualEndDate date-time

data/actualEndDate

copyFrom
copyFrom string

data/copyFrom

Seguidores
followers array of object

Seguidores

userId
followers.userId string

userId

spaceId
spaceId string

data/spaceId

id do modelo
templateId string

data/templateId

updateDiffs
updateDiffs array of object
nome_do_campo
updateDiffs.fieldName string

data/updateDiffs/fieldName

before
updateDiffs.before string

data/updateDiffs/before

after
updateDiffs.after string

data/updateDiffs/after

Configuração analítica
analyticSetting ProgramAnalyticSetting
customProperties
customProperties array of object
id
customProperties.id string

data/customProperties/id

multipleValue
customProperties.multipleValue boolean

data/customProperties/multipleValue

nome
customProperties.name string

data/customProperties/name

customProperties
customProperties.customProperties array of object
id
customProperties.customProperties.id string

data/customProperties/customProperties/id

value
customProperties.customProperties.value string

data/customProperties/customProperties/value

tipo
customProperties.customProperties.type string

data/customProperties/customProperties/type

ProgramRequest

Nome Caminho Tipo Description
ID do atribuídor
assigneeId string

ID do usuário do destinatário

ID do atribuídor
assignerId string

ID do usuário do atribuídor

Associations
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 criada

ID do Criador
creatorId string

ID do usuário do criador

Propriedades personalizadas
customProperties array of CustomPropertyValues

Lista de propriedades personalizadas

Seguidores
followers array of Follower

Lista de seguidores

Ref de Formulário
formRef

Objeto de referência de formulário

ID da Solicitação
id string
Observação
note string

Observação de notificações sobre alterações de status

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término planejada

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início planejada

Priority
priority string

Valor de prioridade

ID do programa
programId string

ID do programa ao qual a solicitação está associada

Classificação
rank string

Classificação da solicitação na lista de solicitações

requestFormCustomPropertyOption
requestFormCustomPropertyOption RequestFormCustomProperties

Propriedades personalizadas do formulário de solicitação

ID do espaço
spaceId string
ID do esquema de status
statusSchemaId string
ID da etapa
stepId integer

ID da etapa que indica o valor do status

Title
title string

Título da solicitação

Atualizado em
updatedAt date-time

Data em que a solicitação foi atualizada pela última vez

ProgramRequestQueryResponse

Nome Caminho Tipo Description
Contagem
count integer

Número de registros retornados

Cursor
cursor string

Cursor usado para paginação

Objetos de solicitação
items array of ProgramRequest

Lista de objetos de solicitação na resposta

Limit
limit integer

Número para limitar registros

Objeto de metadados
meta Meta

Objeto de metadados

PlannerSubTask

Nome Caminho Tipo Description
Duração real
actualDuration integer

Duração real calculada em dias

Data de término real
actualEndDate date-time

Data em que o trabalho na tarefa foi concluído

Data de início real
actualStartDate date-time

Data em que o trabalho na tarefa foi iniciado

ID do atribuídor
assigneeId string

ID do usuário do atribuídor

ID do atribuídor
assignerId string

ID do usuário do último usuário para adicionar um atribuídor

Associations
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 em que a tarefa foi criada

ID do Criador
creatorId string

ID do usuário do criador

Propriedades personalizadas
customProperties array of CustomPropertyValues

Lista de propriedades personalizadas em uma tarefa

Description
description string

Descrição da tarefa

Seguidores
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 Principal
parentId string

ID da tarefa pai se a tarefa for uma subtarefa

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data de término (data de conclusão)

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início

Priority
priority string

Valor de prioridade

ID do programa
programId string

ID do programa à 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 da etapa
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 em que a tarefa foi atualizada pela última vez

ProgramTask

Nome Caminho Tipo Description
Duração real
actualDuration integer

Duração real calculada em dias

Data de término real
actualEndDate date-time

Data em que o trabalho na tarefa foi concluído

Data de início real
actualStartDate date-time

Data em que o trabalho na tarefa foi iniciado

Atribuir ID
assigneeId string

ID do usuário do atribuídor

ID do atribuídor
assignerId string

ID do usuário do último usuário para adicionar um atribuídor

Associations
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 em que a tarefa foi criada

ID do Criador
creatorId string

ID do usuário do criador

Propriedades personalizadas
customProperties array of CustomPropertyValues

Lista de propriedades personalizadas em uma tarefa

Description
description string

Descrição da tarefa

Seguidores
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 Principal
parentId string

ID da tarefa pai se a tarefa for uma subtarefa

Duração Planejada
plannedDuration integer

Duração planejada em dias

Data de término planejada
plannedEndDate date-time

Cadeia de caracteres de data da data de término planejada (data de conclusão)

Data de início planejada
plannedStartDate date-time

Cadeia de caracteres de data da data de início planejada

Priority
priority string

Valor de prioridade

ID do programa
programId string

ID do programa à 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 da etapa
stepId integer

ID da etapa no esquema de status

IDs de subtarefa
subTaskIds array of string

Lista de IDs de subtarefa

Subtarecas
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 em que a tarefa foi atualizada pela última vez

ProgramTaskQueryResponse

Nome Caminho Tipo Description
Contagem
count integer

Número de registros retornados

Cursor
cursor string

Cursor usado para paginação

Objetos de tarefa
items array of ProgramTask

Lista de objetos de tarefa na resposta

Limit
limit integer

Número para limitar registros

Objeto de metadados
meta Meta

Objeto de metadados

PossibleValuesItem

Nome Caminho Tipo Description
ID do valor
id string
Pedido
order integer

Número para indicar a ordem

Value
value

Dados de valor real

ProgramAssociatedNodes

Nome 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

Propriedades personalizadas do formulário de solicitação

Nome Caminho Tipo Description
Criado em
createdAt date-time

Cadeia de caracteres de data da data criada

Propriedades personalizadas
customProperties array of CustomProperty

Lista de propriedades personalizadas

RequestWebhookResponse

Nome Caminho Tipo Description
id
id string

data/id

tenantId
tenantId string

data/tenantId

tenantName
tenantName string

data/tenantName

requestId
requestId string

data/requestId

eventTimestamp
eventTimestamp integer

data/eventTimestamp

actorId
actorId string

data/actorId

spaceId
spaceId string

data/spaceId

title
title string

data/title

assigneeId
assigneeId string

data/assigneeId

assignerId
assignerId string

data/assignerId

creatorId
creatorId string

data/creatorId

plannedStartDate
plannedStartDate date-time

data/plannedStartDate

plannedEndDate
plannedEndDate date-time

data/plannedEndDate

plannedDuration
plannedDuration integer

data/plannedDuration

createdAt
createdAt date-time

data/createdAt

updatedAt
updatedAt date-time

data/updatedAt

status
status string

dados/status

priority
priority string

dados/prioridade

programId
programId string

data/programId

nota
note string

dados/observação

formId
formRef.formId string

data/formRef/formId

minorVersion
formRef.minorVersion integer

data/formRef/minorVersion

Versão principal
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

nome_do_campo
updateDiffs.fieldName string

data/updateDiffs/fieldName

before
updateDiffs.before string

data/updateDiffs/before

after
updateDiffs.after string

data/updateDiffs/after

customProperties
customProperties array of object

dados

id
customProperties.id string

data/customProperties/id

multipleValue
customProperties.multipleValue boolean

data/customProperties/multipleValue

nome
customProperties.name string

data/customProperties/name

customProperties
customProperties.customProperties array of object

customProperties

id
customProperties.customProperties.id string

data/customProperties/customProperties/id

value
customProperties.customProperties.value string

data/customProperties/customProperties/value

tipo
customProperties.customProperties.type string

data/customProperties/customProperties/type

ScopeSettingsItemDefinition

Nome Caminho Tipo Description
É necessário
isRequired boolean

Indicador sobre se um campo é necessário ou não

Scope
scope string

Lista de tipos de nó aos quais a definição de propriedade personalizada pertence

StatusSchema

Nome Caminho Tipo Description
Criado em
createdAt date-time

Cadeia de caracteres de data da data criada

ID do Criador
creatorId string

ID do usuário 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 em que o esquema de status foi atualizado pela última vez

StatusSchemaQueryResponse

Nome Caminho Tipo Description
Contagem
count integer

Número de registros retornados

Cursor
cursor string

Cursor usado para paginação

Objetos de esquema de status
items array of StatusSchema

Lista de objetos de esquema de status na resposta

Limit
limit integer

Número para limitar registros

Objeto de metadados
meta Meta

Objeto de metadados

TaskWebhookResponse

Nome Caminho Tipo Description
id
id string

data/id

tenantId
tenantId string

data/tenantId

tenantName
tenantName string

data/tenantName

taskId
taskId string

data/taskId

eventTimestamp
eventTimestamp integer

data/eventTimestamp

actorId
actorId string

data/actorId

spaceId
spaceId string

data/spaceId

title
title string

data/title

descrição
description string

dados/descrição

assigneeId
assigneeId string

data/assigneeId

assignerId
assignerId string

data/assignerId

creatorId
creatorId string

data/creatorId

plannedStartDate
plannedStartDate date-time

data/plannedStartDate

plannedEndDate
plannedEndDate date-time

data/plannedEndDate

plannedDuration
plannedDuration integer

data/plannedDuration

actualStartDate
actualStartDate date-time

data/actualStartDate

actualEndDate
actualEndDate date-time

data/actualEndDate

actualDuration
actualDuration integer

data/actualDuration

createdAt
createdAt date-time

data/createdAt

updatedAt
updatedAt date-time

data/updatedAt

status
status string

dados/status

priority
priority string

dados/prioridade

ID do pai
parentId string

data/parentId

programId
programId string

data/programId

copyFrom
copyFrom string

data/copyFrom

Seguidores
followers array of object

Seguidores

userId
followers.userId string

userId

id do modelo
templateId string

data/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
nome_do_campo
updateDiffs.fieldName string

data/updateDiffs/fieldName

before
updateDiffs.before string

data/updateDiffs/before

after
updateDiffs.after string

data/updateDiffs/after

customProperties
customProperties array of object

dados

id
customProperties.id string

data/customProperties/id

multipleValue
customProperties.multipleValue boolean

data/customProperties/multipleValue

nome
customProperties.name string

data/customProperties/name

customProperties
customProperties.customProperties array of object

customProperties

id
customProperties.customProperties.id string

data/customProperties/customProperties/id

value
customProperties.customProperties.value string

data/customProperties/customProperties/value

tipo
customProperties.customProperties.type string

data/customProperties/customProperties/type

ValueSchemaPropertyDefinition

Definição de esquema de valor

Nome Caminho Tipo Description
Número máximo
max string
Número mínimo
min string