Pular para o conteúdo
TAI TAI Desenvolvedores

Abrir solicitação pelo nome do fluxo, com os campos pelo nome

POST
/card/abrir-solicitacao

Autorização
Módulo contratado: GESTAO_PROCESSOS
Permissão: qualquer usuário autenticado da empresa

Authorizations

Seção intitulada “Authorizations ”

Request Body required

Seção intitulada “Request Body required ”
object
fluxo

Nome do fluxo (processo) em que abrir a solicitação, como o usuário o chama (ex.: ‘Solicitação de Compras’). Precisa ser um fluxo em que ele pode abrir solicitação.

string
fluxoId

Alternativa a ‘fluxo’: o id do fluxo, quando já resolvido por uma consulta.

integer format: int64
resumo

Uma linha do que é o pedido (aparece no card).

string
campos

Valores dos campos do formulário: {“nome do campo como na tela, ou identificador”: valor}. Campo que o fluxo não tem é recusado com a lista dos campos dele.

object
key
additional properties

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

OK

Partial entity data with ID (only non-null fields will be updated)

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
pipe

Partial entity data with ID (only non-null fields will be updated)

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
descricao
string
icone
string
cor
string
tipo
string
Allowed values: RH COMPRAS FINANCEIRO SUPORTE JURIDICO TI GENERICO
modoVisualizacao
string
Allowed values: GESTAO_A_VISTA GESTAO_PRIVADA
publico
boolean
slaDiasTotal
integer format: int32
avisosPadrao
boolean
abertoATodos
boolean
enviarAoAbrir
boolean
modeloChave
string
dataCriacao
string format: date-time
categoriaId
integer format: int64
gedPastaId
integer format: int64
gedPastaPath
string
criarPastaPorCard
boolean
totalCards
integer format: int32
cardsAtivos
integer format: int32
cardsConcluidos
integer format: int32
cardsSlaVencido
integer format: int32
phaseAtual

Partial entity data with ID (only non-null fields will be updated)

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
pipeId
integer format: int64
nome
string
descricao
string
cor
string
ordem
integer format: int32
tipo
string
Allowed values: INICIO PROCESSAMENTO APROVACAO FINALIZACAO
isDone
boolean
slaHoras
integer format: int32
limiteCards
integer format: int32
bloquearAcimaLimite
boolean
fasesDestinoPermitidas
string
requerAprovacao
boolean
autoAtribuir
boolean
aprovadorDinamico
string
aprovadorCampo
string
opcional
boolean
entrarSe
string
aprovadoresIds
Array<integer>
aprovadoresCargoIds
Array<integer>
aprovadoresDepartamentoIds
Array<integer>
modoAprovacao
string
Allowed values: QUALQUER TODOS QUORUM
quorumMinimo
integer format: int32
criarGedWorkflowAutomatico
boolean
fieldSchemaAprovacaoGedId
integer format: int64
fieldSchemaAprovacaoGedNome
string
aprovadorGedColaboradorId
integer format: int64
aprovadorGedColaboradorNome
string
numero
integer format: int64
status
string
Allowed values: ABERTO EM_ANDAMENTO AGUARDANDO BLOQUEADO CONCLUIDO CANCELADO
dataCriacao
string format: date-time
dataConclusao
string format: date-time
dataVencimentoSla
string format: date-time
slaVencido
boolean
dataEntradaFase
string format: date-time
colaboradorCriador

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
dataNascimento
string format: date-time
genero
string
Allowed values: MASCULINO FEMININO NAO_BINARIO OUTRO PREFIRO_NAO_INFORMAR
nacionalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cpf
string
/^(\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2})$/
rg
string
0 <= 20 characters /^[\d.\-A-Za-z]+$/
estadoCivil
string
Allowed values: SOLTEIRO CASADO DIVORCIADO VIUVO UNIAO_ESTAVEL
telefone
string
0 <= 20 characters /^[\d\s\-().+]+$/
emailPessoal
string format: email
0 <= 255 characters
emailCorporativo
string format: email
0 <= 255 characters
linkedin
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
endereco
string
0 <= 500 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
codigoFuncionario
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
codigoPosicao
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
tipoContrato
string
Allowed values: CLT PJ ESTAGIO TEMPORARIO TERCEIRIZADO APRENDIZ INTERMITENTE SOCIO_SERVICO AUTONOMO
dataAdmissao
string format: date-time
nivelHierarquico
string
Allowed values: ESTAGIARIO TREINEE JUNIOR PLENO SENIOR COORDENADOR GERENTE ESPECIALISTA SUPERINTENDENTE DIRETOR VICE_PRESIDENTE C_LEVEL
regimeTrabalho
string
Allowed values: INTEGRAL PARCIAL PRESENCIAL REMOTO HIBRIDO
horarioTrabalho
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
beneficios
string
0 <= 1000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
pis
string
/^\d{11}$/
ctps
string
0 <= 30 characters /^[\d.\-/]+$/
nis
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
informacoesSaude
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
fotoUrl
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
idiomas
Array<string>
enviarEmail
boolean
nomeSocial
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
apelido
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
naturalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
estadoNatal
string
0 <= 2 characters /^[A-Z]{2}$/
fumante
boolean
corRaca
string
Allowed values: BRANCA PRETA PARDA AMARELA INDIGENA NAO_INFORMADO
tipoSanguineo
string
Allowed values: A_POSITIVO A_NEGATIVO B_POSITIVO B_NEGATIVO AB_POSITIVO AB_NEGATIVO O_POSITIVO O_NEGATIVO
grauInstrucao
string
Allowed values: ANALFABETO FUNDAMENTAL_ATE_5_ANO_INCOMPLETO FUNDAMENTAL_5_ANO_COMPLETO FUNDAMENTAL_6_AO_9_ANO FUNDAMENTAL_COMPLETO MEDIO_INCOMPLETO MEDIO_COMPLETO SUPERIOR_INCOMPLETO SUPERIOR_COMPLETO POS_GRADUACAO_INCOMPLETA POS_GRADUACAO_COMPLETA MESTRADO_INCOMPLETO MESTRADO_COMPLETO DOUTORADO_INCOMPLETO DOUTORADO_COMPLETO POS_DOUTORADO_INCOMPLETO POS_DOUTORADO_COMPLETO
cep
string
0 <= 9 characters /^(\d{8}|\d{5}-\d{3})$/
logradouro
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
enderecoNumero
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
complemento
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
bairro
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
enderecoUf
string
0 <= 2 characters /^[A-Z]{2}$/
pais
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
telefone2
string
0 <= 20 characters /^[\d\s\-().+]+$/
telefone3
string
0 <= 20 characters /^[\d\s\-().+]+$/
ramal
string
0 <= 10 characters /^$|^\d+$/
rgOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
rgUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
rgDataEmissao
string format: date-time
tituloEleitor
string
0 <= 12 characters /^\d{12}$/
tituloEleitorZona
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorSecao
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorDataEmissao
string format: date-time
tituloEleitorUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsSerie
string
0 <= 20 characters /^[\d.\-/]+$/
ctpsDataEmissao
string format: date-time
ctpsUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsDigital
boolean
cnh
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
cnhCategoria
string
Allowed values: A B C D E AB AC AD AE
cnhDataEmissao
string format: date-time
cnhDataVencimento
string format: date-time
cnhOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cnhDataPrimeira
string format: date-time
cnhUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
certReservista
string
0 <= 30 characters /^[a-zA-Z0-9]+$/
categoriaMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
circunscricaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
regiaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
certReservistaDataEmissao
string format: date-time
certReservistaOrgaoExpedicao
string
0 <= 50 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
situacaoMilitar
string
Allowed values: RESERVISTA DISPENSADO ALISTADO NAO_SE_APLICA EXCESSO_CONTINGENTE REFORMADO
matriculaEsocial
string
0 <= 30 characters
codCategoria
string
tipoRegimeTrabalhista
string
tipoRegimePrevidenciario
string
tipoAdmissao
string
indicativoAdmissao
string
naturezaAtividade
string
tipoRegimeJornada
string
defFisica
boolean
defVisual
boolean
defAuditiva
boolean
defMental
boolean
defIntelectual
boolean
reabilitadoReadaptado
boolean
preencheCotaPcd
boolean
observacaoDeficiencia
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
municipioId
integer format: int64
municipioDescricao
string
tipoLogradouro
string
sexoEsocial
string
grauInstrucaoEsocial
string
paisNascimento
string
paisNacionalidade
string
tipoContratoPrazo
string
dataTerminoContrato
string format: date-time
clausulaAssecuratoria
boolean
objetoDeterminante
string
0 <= 255 characters
tipoJornadaEsocial
string
tempoParcial
string
horasSemanais
number
horarioNoturno
boolean
descricaoJornada
string
0 <= 999 characters
dataOpcaoFgts
string format: date-time
esocialReciboAdmissao
string
0 <= 40 characters
tipoRua
string
tipoBairro
string
tipoFuncionarioTotvs
string
fichaRegistroTotvs
string
tipoAdmissaoTotvs
string
motivoAdmissaoTotvs
string
motivoMudancaTotvs
string
tipoRecebimentoTotvs
string
situacaoTotvs
string
jornadaMensalTotvs
string
horarioTotvs
string
letraHorarioTotvs
string
sindicatoTotvs
string
contribuicaoSindicalTotvs
string
ocorrenciaSefipTotvs
string
categoriaSefipTotvs
string
situacaoFgtsTotvs
string
situacaoRaisTotvs
string
calculaInssTotvs
boolean
calculaIrrfTotvs
boolean
percentualAdiantamentoTotvs
number
desligado
boolean
dataDesligamento
string format: date-time
motivoDesligamento
string
Allowed values: DEMISSAO_SEM_JUSTA_CAUSA DEMISSAO_COM_JUSTA_CAUSA PEDIDO_DEMISSAO ACORDO_MUTUO TERMINO_CONTRATO APOSENTADORIA FALECIMENTO TRANSFERENCIA_EMPRESA OUTRO
observacaoDesligamento
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
responsavel

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
dataNascimento
string format: date-time
genero
string
Allowed values: MASCULINO FEMININO NAO_BINARIO OUTRO PREFIRO_NAO_INFORMAR
nacionalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cpf
string
/^(\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2})$/
rg
string
0 <= 20 characters /^[\d.\-A-Za-z]+$/
estadoCivil
string
Allowed values: SOLTEIRO CASADO DIVORCIADO VIUVO UNIAO_ESTAVEL
telefone
string
0 <= 20 characters /^[\d\s\-().+]+$/
emailPessoal
string format: email
0 <= 255 characters
emailCorporativo
string format: email
0 <= 255 characters
linkedin
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
endereco
string
0 <= 500 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
codigoFuncionario
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
codigoPosicao
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
tipoContrato
string
Allowed values: CLT PJ ESTAGIO TEMPORARIO TERCEIRIZADO APRENDIZ INTERMITENTE SOCIO_SERVICO AUTONOMO
dataAdmissao
string format: date-time
nivelHierarquico
string
Allowed values: ESTAGIARIO TREINEE JUNIOR PLENO SENIOR COORDENADOR GERENTE ESPECIALISTA SUPERINTENDENTE DIRETOR VICE_PRESIDENTE C_LEVEL
regimeTrabalho
string
Allowed values: INTEGRAL PARCIAL PRESENCIAL REMOTO HIBRIDO
horarioTrabalho
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
beneficios
string
0 <= 1000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
pis
string
/^\d{11}$/
ctps
string
0 <= 30 characters /^[\d.\-/]+$/
nis
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
informacoesSaude
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
fotoUrl
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
idiomas
Array<string>
enviarEmail
boolean
nomeSocial
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
apelido
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
naturalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
estadoNatal
string
0 <= 2 characters /^[A-Z]{2}$/
fumante
boolean
corRaca
string
Allowed values: BRANCA PRETA PARDA AMARELA INDIGENA NAO_INFORMADO
tipoSanguineo
string
Allowed values: A_POSITIVO A_NEGATIVO B_POSITIVO B_NEGATIVO AB_POSITIVO AB_NEGATIVO O_POSITIVO O_NEGATIVO
grauInstrucao
string
Allowed values: ANALFABETO FUNDAMENTAL_ATE_5_ANO_INCOMPLETO FUNDAMENTAL_5_ANO_COMPLETO FUNDAMENTAL_6_AO_9_ANO FUNDAMENTAL_COMPLETO MEDIO_INCOMPLETO MEDIO_COMPLETO SUPERIOR_INCOMPLETO SUPERIOR_COMPLETO POS_GRADUACAO_INCOMPLETA POS_GRADUACAO_COMPLETA MESTRADO_INCOMPLETO MESTRADO_COMPLETO DOUTORADO_INCOMPLETO DOUTORADO_COMPLETO POS_DOUTORADO_INCOMPLETO POS_DOUTORADO_COMPLETO
cep
string
0 <= 9 characters /^(\d{8}|\d{5}-\d{3})$/
logradouro
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
enderecoNumero
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
complemento
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
bairro
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
enderecoUf
string
0 <= 2 characters /^[A-Z]{2}$/
pais
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
telefone2
string
0 <= 20 characters /^[\d\s\-().+]+$/
telefone3
string
0 <= 20 characters /^[\d\s\-().+]+$/
ramal
string
0 <= 10 characters /^$|^\d+$/
rgOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
rgUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
rgDataEmissao
string format: date-time
tituloEleitor
string
0 <= 12 characters /^\d{12}$/
tituloEleitorZona
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorSecao
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorDataEmissao
string format: date-time
tituloEleitorUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsSerie
string
0 <= 20 characters /^[\d.\-/]+$/
ctpsDataEmissao
string format: date-time
ctpsUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsDigital
boolean
cnh
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
cnhCategoria
string
Allowed values: A B C D E AB AC AD AE
cnhDataEmissao
string format: date-time
cnhDataVencimento
string format: date-time
cnhOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cnhDataPrimeira
string format: date-time
cnhUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
certReservista
string
0 <= 30 characters /^[a-zA-Z0-9]+$/
categoriaMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
circunscricaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
regiaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
certReservistaDataEmissao
string format: date-time
certReservistaOrgaoExpedicao
string
0 <= 50 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
situacaoMilitar
string
Allowed values: RESERVISTA DISPENSADO ALISTADO NAO_SE_APLICA EXCESSO_CONTINGENTE REFORMADO
matriculaEsocial
string
0 <= 30 characters
codCategoria
string
tipoRegimeTrabalhista
string
tipoRegimePrevidenciario
string
tipoAdmissao
string
indicativoAdmissao
string
naturezaAtividade
string
tipoRegimeJornada
string
defFisica
boolean
defVisual
boolean
defAuditiva
boolean
defMental
boolean
defIntelectual
boolean
reabilitadoReadaptado
boolean
preencheCotaPcd
boolean
observacaoDeficiencia
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
municipioId
integer format: int64
municipioDescricao
string
tipoLogradouro
string
sexoEsocial
string
grauInstrucaoEsocial
string
paisNascimento
string
paisNacionalidade
string
tipoContratoPrazo
string
dataTerminoContrato
string format: date-time
clausulaAssecuratoria
boolean
objetoDeterminante
string
0 <= 255 characters
tipoJornadaEsocial
string
tempoParcial
string
horasSemanais
number
horarioNoturno
boolean
descricaoJornada
string
0 <= 999 characters
dataOpcaoFgts
string format: date-time
esocialReciboAdmissao
string
0 <= 40 characters
tipoRua
string
tipoBairro
string
tipoFuncionarioTotvs
string
fichaRegistroTotvs
string
tipoAdmissaoTotvs
string
motivoAdmissaoTotvs
string
motivoMudancaTotvs
string
tipoRecebimentoTotvs
string
situacaoTotvs
string
jornadaMensalTotvs
string
horarioTotvs
string
letraHorarioTotvs
string
sindicatoTotvs
string
contribuicaoSindicalTotvs
string
ocorrenciaSefipTotvs
string
categoriaSefipTotvs
string
situacaoFgtsTotvs
string
situacaoRaisTotvs
string
calculaInssTotvs
boolean
calculaIrrfTotvs
boolean
percentualAdiantamentoTotvs
number
desligado
boolean
dataDesligamento
string format: date-time
motivoDesligamento
string
Allowed values: DEMISSAO_SEM_JUSTA_CAUSA DEMISSAO_COM_JUSTA_CAUSA PEDIDO_DEMISSAO ACORDO_MUTUO TERMINO_CONTRATO APOSENTADORIA FALECIMENTO TRANSFERENCIA_EMPRESA OUTRO
observacaoDesligamento
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
departamentoResponsavel

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
descricao
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
objetivos
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
codigo
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
setorAssociado
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
nomeResponsavel
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
colaborador
responsavelOriginal

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
nome
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
dataNascimento
string format: date-time
genero
string
Allowed values: MASCULINO FEMININO NAO_BINARIO OUTRO PREFIRO_NAO_INFORMAR
nacionalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cpf
string
/^(\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2})$/
rg
string
0 <= 20 characters /^[\d.\-A-Za-z]+$/
estadoCivil
string
Allowed values: SOLTEIRO CASADO DIVORCIADO VIUVO UNIAO_ESTAVEL
telefone
string
0 <= 20 characters /^[\d\s\-().+]+$/
emailPessoal
string format: email
0 <= 255 characters
emailCorporativo
string format: email
0 <= 255 characters
linkedin
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
endereco
string
0 <= 500 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
codigoFuncionario
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
codigoPosicao
string
0 <= 50 characters /^[a-zA-Z0-9\-_]+$/
tipoContrato
string
Allowed values: CLT PJ ESTAGIO TEMPORARIO TERCEIRIZADO APRENDIZ INTERMITENTE SOCIO_SERVICO AUTONOMO
dataAdmissao
string format: date-time
nivelHierarquico
string
Allowed values: ESTAGIARIO TREINEE JUNIOR PLENO SENIOR COORDENADOR GERENTE ESPECIALISTA SUPERINTENDENTE DIRETOR VICE_PRESIDENTE C_LEVEL
regimeTrabalho
string
Allowed values: INTEGRAL PARCIAL PRESENCIAL REMOTO HIBRIDO
horarioTrabalho
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
beneficios
string
0 <= 1000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
pis
string
/^\d{11}$/
ctps
string
0 <= 30 characters /^[\d.\-/]+$/
nis
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
informacoesSaude
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
fotoUrl
string
0 <= 500 characters /^(https?://)?[\w\-.]+(:\d+)?(/[\w\-./?%&=@#]*)?$/
idiomas
Array<string>
enviarEmail
boolean
nomeSocial
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
apelido
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
naturalidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
estadoNatal
string
0 <= 2 characters /^[A-Z]{2}$/
fumante
boolean
corRaca
string
Allowed values: BRANCA PRETA PARDA AMARELA INDIGENA NAO_INFORMADO
tipoSanguineo
string
Allowed values: A_POSITIVO A_NEGATIVO B_POSITIVO B_NEGATIVO AB_POSITIVO AB_NEGATIVO O_POSITIVO O_NEGATIVO
grauInstrucao
string
Allowed values: ANALFABETO FUNDAMENTAL_ATE_5_ANO_INCOMPLETO FUNDAMENTAL_5_ANO_COMPLETO FUNDAMENTAL_6_AO_9_ANO FUNDAMENTAL_COMPLETO MEDIO_INCOMPLETO MEDIO_COMPLETO SUPERIOR_INCOMPLETO SUPERIOR_COMPLETO POS_GRADUACAO_INCOMPLETA POS_GRADUACAO_COMPLETA MESTRADO_INCOMPLETO MESTRADO_COMPLETO DOUTORADO_INCOMPLETO DOUTORADO_COMPLETO POS_DOUTORADO_INCOMPLETO POS_DOUTORADO_COMPLETO
cep
string
0 <= 9 characters /^(\d{8}|\d{5}-\d{3})$/
logradouro
string
0 <= 255 characters /^[\p{L}\p{N}\s\-.,;:/°ºª()]+$/
enderecoNumero
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
complemento
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
bairro
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cidade
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
enderecoUf
string
0 <= 2 characters /^[A-Z]{2}$/
pais
string
0 <= 100 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
telefone2
string
0 <= 20 characters /^[\d\s\-().+]+$/
telefone3
string
0 <= 20 characters /^[\d\s\-().+]+$/
ramal
string
0 <= 10 characters /^$|^\d+$/
rgOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
rgUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
rgDataEmissao
string format: date-time
tituloEleitor
string
0 <= 12 characters /^\d{12}$/
tituloEleitorZona
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorSecao
string
0 <= 10 characters /^[a-zA-Z0-9]+$/
tituloEleitorDataEmissao
string format: date-time
tituloEleitorUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsSerie
string
0 <= 20 characters /^[\d.\-/]+$/
ctpsDataEmissao
string format: date-time
ctpsUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
ctpsDigital
boolean
cnh
string
0 <= 20 characters /^[a-zA-Z0-9]+$/
cnhCategoria
string
Allowed values: A B C D E AB AC AD AE
cnhDataEmissao
string format: date-time
cnhDataVencimento
string format: date-time
cnhOrgaoEmissor
string
0 <= 20 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
cnhDataPrimeira
string format: date-time
cnhUfEmissor
string
0 <= 2 characters /^[A-Z]{2}$/
certReservista
string
0 <= 30 characters /^[a-zA-Z0-9]+$/
categoriaMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
circunscricaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
regiaoMilitar
string
0 <= 30 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
certReservistaDataEmissao
string format: date-time
certReservistaOrgaoExpedicao
string
0 <= 50 characters /^[\p{L}\p{N}\s\-.,()'’]+$/
situacaoMilitar
string
Allowed values: RESERVISTA DISPENSADO ALISTADO NAO_SE_APLICA EXCESSO_CONTINGENTE REFORMADO
matriculaEsocial
string
0 <= 30 characters
codCategoria
string
tipoRegimeTrabalhista
string
tipoRegimePrevidenciario
string
tipoAdmissao
string
indicativoAdmissao
string
naturezaAtividade
string
tipoRegimeJornada
string
defFisica
boolean
defVisual
boolean
defAuditiva
boolean
defMental
boolean
defIntelectual
boolean
reabilitadoReadaptado
boolean
preencheCotaPcd
boolean
observacaoDeficiencia
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
municipioId
integer format: int64
municipioDescricao
string
tipoLogradouro
string
sexoEsocial
string
grauInstrucaoEsocial
string
paisNascimento
string
paisNacionalidade
string
tipoContratoPrazo
string
dataTerminoContrato
string format: date-time
clausulaAssecuratoria
boolean
objetoDeterminante
string
0 <= 255 characters
tipoJornadaEsocial
string
tempoParcial
string
horasSemanais
number
horarioNoturno
boolean
descricaoJornada
string
0 <= 999 characters
dataOpcaoFgts
string format: date-time
esocialReciboAdmissao
string
0 <= 40 characters
tipoRua
string
tipoBairro
string
tipoFuncionarioTotvs
string
fichaRegistroTotvs
string
tipoAdmissaoTotvs
string
motivoAdmissaoTotvs
string
motivoMudancaTotvs
string
tipoRecebimentoTotvs
string
situacaoTotvs
string
jornadaMensalTotvs
string
horarioTotvs
string
letraHorarioTotvs
string
sindicatoTotvs
string
contribuicaoSindicalTotvs
string
ocorrenciaSefipTotvs
string
categoriaSefipTotvs
string
situacaoFgtsTotvs
string
situacaoRaisTotvs
string
calculaInssTotvs
boolean
calculaIrrfTotvs
boolean
percentualAdiantamentoTotvs
number
desligado
boolean
dataDesligamento
string format: date-time
motivoDesligamento
string
Allowed values: DEMISSAO_SEM_JUSTA_CAUSA DEMISSAO_COM_JUSTA_CAUSA PEDIDO_DEMISSAO ACORDO_MUTUO TERMINO_CONTRATO APOSENTADORIA FALECIMENTO TRANSFERENCIA_EMPRESA OUTRO
observacaoDesligamento
string
0 <= 2000 characters /^[\p{L}\p{N}\s\-.,;:!?()\[\]{}'"/\\@#$%&*+=°ºª|~^`´\r\n]+$/
cardPai

Partial entity data with ID (only non-null fields will be updated)

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
numero
integer format: int64
status
string
Allowed values: ABERTO EM_ANDAMENTO AGUARDANDO BLOQUEADO CONCLUIDO CANCELADO
dataCriacao
string format: date-time
dataConclusao
string format: date-time
dataVencimentoSla
string format: date-time
slaVencido
boolean
dataEntradaFase
string format: date-time
origemExterna
boolean
origemReferencia
string
resumoCard
string
votosFaltantes
integer format: int32
mensagemAprovacao
string
origemExterna
boolean
origemReferencia
string
resumoCard
string
fieldValues
Array<object>

Partial entity data with ID (only non-null fields will be updated)

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
cardId
integer format: int64
fieldSchemaId
integer format: int64
fieldNome
string
fieldIdentificador
string
fieldTipo
string
Allowed values: TEXTO TEXTO_LONGO NUMERO MOEDA PERCENTUAL DATA DATETIME SELECT MULTISELECT CHECKBOX EMAIL TELEFONE CPF CNPJ ARQUIVO LINK COLABORADOR COLABORADORES DEPARTAMENTO CENTRO_CUSTO LABEL RICH_TEXT
valorTexto
string
valorNumero
number format: double
valorData
string format: date-time
valorBoolean
boolean
valorArquivoUrl
string
valorArquivoNome
string
valorReferenciaId
integer format: int64
valorReferenciaTipo
string
valorJson
string
valorFormatado
string
gedDocumentoId
integer format: int64
gedVersaoNumero
integer format: int32
gedTitulo
string
cardPhases
Array<object>

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
cardId
integer format: int64
dataEntrada
string format: date-time
dataSaida
string format: date-time
tempoPermanenciaMinutos
integer format: int64
resultado
string
Allowed values: APROVADO REPROVADO AVANCADO RETROCEDIDO DISPENSADO
observacao
string
slaVencidoNaFase
boolean
dataDecisao
string format: date-time
votos
Array<object>
object
key
additional properties
movimentacoes
Array<object>

Partial entity data with ID (only non-null fields will be updated)

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
cardId
integer format: int64
dataMovimentacao
string format: date-time
tipo
string
Allowed values: AVANCO RETROCESSO ROTEAMENTO_IA AUTOMACAO MANUAL PULO
motivo
string
automationId
integer format: int64
iaClassificacao
string
iaConfianca
number format: double
comments
Array<object>

Partial entity data with ID (only non-null fields will be updated)

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
cardId
integer format: int64
conteudo
string
dataCriacao
string format: date-time
tipo
string
Allowed values: MANUAL SISTEMA IA AUTOMACAO
isInterno
boolean
commentPaiId
integer format: int64
anexos
Array<object>

Partial entity data with ID (only non-null fields will be updated)

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
id
integer format: int64
active
boolean
createdAt
string format: date-time
cardId
integer format: int64
nome
string
nomeOriginal
string
url
string
tipoMime
string
tamanhoBytes
integer format: int64
dataUpload
string format: date-time
descricao
string
camposFaseAtual
Array<object>

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object
phaseFieldId
integer format: int64
visivel
boolean
editavel
boolean
obrigatorioNestaFase
boolean
ordem
integer format: int32
regraVisibilidade
string
valorTexto
string
valorNumero
number format: double
valorData
string format: date-time
valorBoolean
boolean
valorArquivoUrl
string
valorArquivoNome
string
valorReferenciaId
integer format: int64
valorReferenciaTipo
string
valorFormatado
string
preenchido
boolean
votosFaltantes
integer format: int32
mensagemAprovacao
string

Referência gerada do contrato da API em 30 de outubro de 2026. taitecnologia.com · Termos de uso · Privacidade

© 2026 T AI TECNOLOGIA LTDA