Mais pesquisados:Customização, Tutorial, Documentação

tck

1918 views 0 06/03/2020 Atualizado em 06/09/2024 integrador

2.0info: 3.28.3 tck description: Serviço Tracking – Rastreamento x-senior-domain: tms x-senior-domain-path: tms x-senior-service-path: tck contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /tck/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/consultaFilial: post: description: Verifica se a Filial passada como parametro, existe no Tracking tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: Informa o CNPJ da filial que deseja buscar no banco de dados responses: 200: description: Ok schema: type: object required: – filial – ok properties: filial: type: object allOf: – #/definitions/filial description: Retorna a filial encontrada no banco de dados msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se a Filial passada como parametro, existe no Tracking tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpj description: Informa o CNPJ da filial que deseja buscar no banco de dados in: query required: true type: string responses: 200: description: Ok schema: type: object required: – filial – ok properties: filial: type: object allOf: – #/definitions/filial description: Retorna a filial encontrada no banco de dados msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/consultaTracking: post: description: Recebe parametros para realizar um filtro e retornar uma Lista de trackings tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filial: type: object allOf: – #/definitions/filial description: Empresa a ser filtrada tipoDocumento: type: object allOf: – #/definitions/tipoDocumento description: Tipo de Documento a ser filtrado situacao: type: object allOf: – #/definitions/situacao description: Situação a ser filtrada fase: type: object allOf: – #/definitions/fase description: Fase a ser filtrada documento: type: string description: Documento a ser filtrado serie: type: string description: Serie do documento a ser filtrado identificadorCliente: type: string description: Identificador do cliente a ser filtrado inscricaoFiscal: type: string description: Cliente relacionado ao tracking codigoTracking: type: string description: Código do Tracking a ser filtrado dataInicio: type: string format: date-time description: Data Inicial a ser filtrado dataFim: type: string format: date-time description: Data Final a ser filtrado createdBy: type: string description: Usuário a ser filtrado pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – listaTracking – ok – totalRegistros properties: listaTracking: type: array items: type: object allOf: – #/definitions/trackingRec minimum: 1 description: Lista de trackings filtrados msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/consultaURLCSVTrackingNotificacao: post: description: Obtém Url para baixar o CSV de uma Lista de trackings via notificação da Senior X tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filial: type: object allOf: – #/definitions/filial description: Empresa a ser filtrada tipoDocumento: type: object allOf: – #/definitions/tipoDocumento description: Tipo de Documento a ser filtrado situacao: type: object allOf: – #/definitions/situacao description: Situação a ser filtrada fase: type: object allOf: – #/definitions/fase description: Fase a ser filtrada documento: type: string description: Documento a ser filtrado serie: type: string description: Serie do documento a ser filtrado identificadorCliente: type: string description: Identificador do cliente a ser filtrado inscricaoFiscal: type: string description: Cliente relacionado ao tracking codigoTracking: type: string description: Código do Tracking a ser filtrado dataInicio: type: string format: date-time description: Data Inicial a ser filtrado dataFim: type: string format: date-time description: Data Final a ser filtrado createdBy: type: string description: Usuário a ser filtrado pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/buscaLinkExterno: post: description: Retorna os links externos para consultar o Tracking tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – listaLinkExterno – ok properties: listaLinkExterno: type: array items: type: object allOf: – #/definitions/LinkRec minimum: 1 description: Retorna a lista de links disponíveis msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os links externos para consultar o Tracking tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – listaLinkExterno – ok properties: listaLinkExterno: type: array items: type: object allOf: – #/definitions/LinkRec minimum: 1 description: Retorna a lista de links disponíveis msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/buscaDocumentosEEnvolvidos: post: description: Obtém lista de documentos e envolvidos de um tracking tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – trackingId properties: trackingId: type: string description: Uuid tracking responses: 200: description: Ok schema: type: object required: – documentosEEnvolvidos – ok properties: documentosEEnvolvidos: type: array items: type: object allOf: – #/definitions/documentosEEnvolvidosRec minimum: 1 description: Documentos e envolvidos msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém lista de documentos e envolvidos de um tracking tags: – Queries x-senior-visibility: PRIVATE parameters: – name: trackingId description: Uuid tracking in: query required: true type: string responses: 200: description: Ok schema: type: object required: – documentosEEnvolvidos – ok properties: documentosEEnvolvidos: type: array items: type: object allOf: – #/definitions/documentosEEnvolvidosRec minimum: 1 description: Documentos e envolvidos msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/buscaInformacoesContatoFilial: post: description: Retorna as informações de contato da Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filialId: type: string description: responses: 200: description: Ok schema: type: object required: – informacoesContato properties: informacoesContato: type: object allOf: – #/definitions/recFaleconosco description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações de contato da Filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filialId description: in: query type: string responses: 200: description: Ok schema: type: object required: – informacoesContato properties: informacoesContato: type: object allOf: – #/definitions/recFaleconosco description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/buscarTotaisTrackingFaseAtual: post: description: Retorna os totalizadores de trackings com a última fase executada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataInicio – dataFim properties: filial: type: object allOf: – #/definitions/filialInputRec description: Id da Filial dataInicio: type: string format: date-time description: Data Inicial a ser filtrado dataFim: type: string format: date-time description: Data Final a ser filtrado fases: type: array items: type: object allOf: – #/definitions/faseInputRec description: Fases responses: 200: description: Ok schema: type: object required: – totalizadores – totalTrackings properties: totalizadores: type: array items: type: object allOf: – #/definitions/recTotalizadorFase minimum: 1 description: Totalizador de tracking por última fase executada totalTrackings: type: integer format: int64 description: Quantidade de trackings contabilizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/buscaPermissoesUsuario: post: description: Busca propriedades dos papéis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ocultarDataPrevisaoEntrega properties: ocultarDataPrevisaoEntrega: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca propriedades dos papéis tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ocultarDataPrevisaoEntrega properties: ocultarDataPrevisaoEntrega: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/consultaTrackingDetalhe: post: description: Consulta o tracking e retorna as fases e os documentos vinculados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/consultaTrackingInputRec description: Filtros para consultar o tracking responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: object allOf: – #/definitions/consultaTrackingOutputRec description: Informações encontradas na consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportEmpresa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportSituacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportPapel: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportCliente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportTipoDocumento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportTipoCliente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportClientePapel: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportDocumento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportPlano: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportChatbot: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportChatbotFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportNotificacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportFase: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportPlanoFase: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportClienteDocumento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportTracking: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportTrackingSituacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportTrackingCliente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportTrackingDocumento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportTrackingFase: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportFaleconosco: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/exportFaleconoscoFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/deletaListaPlanoFase: post: description: Recebe um Plano e exclui o relacionamento desse plano no PlanoFase tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – plano properties: plano: type: object allOf: – #/definitions/plano description: Plano ao qual será inserido as fases responses: 200: description: Ok schema: type: object required: – ok properties: msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/executaTrackingFase: post: description: execução da fase do tracking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tipoDocumento: type: object allOf: – #/definitions/tipoDocumentoRec description: Tipo de Documento a ser executada a fase documento: type: string description: Documento a ser executada a fase serie: type: string description: Serie do documento a ser executada a fase identificadorCliente: type: string description: Identificador do cliente a ser executada a fase codigoTracking: type: string description: Código do Tracking a ser executada a fase fase: type: object allOf: – #/definitions/faseRec description: Fase a ser executada encerrarTracking: type: boolean description: Efetuar o encerramento do tracking default: false codigoExterno: type: integer format: int64 description: Código externo para controle da fase default: 0 dataExecucao: type: string format: date-time description: Data execução transferirAcoes: type: boolean description: Define se as novas movimentações e novos documentos devem ser inclusos nos trackings gerados em casos de Trackings Transferidos. default: false responses: 200: description: Ok schema: type: object required: – ok properties: msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/salvaTracking: post: description: Endpoint para salvar o tracking e suas dependências tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoPlano: type: integer format: int64 description: Código do Plano cnpjFilial: type: string description: CNPJ da Filial codigoTracking: type: string description: Código de Rastreio dsObservacao: type: string description: Observação dataPrevisaoEntrega: type: string format: date-time description: Data de previsão de entrega listaTrackingFase: type: array items: type: object allOf: – #/definitions/trackingFaseRec description: Lista de TrackingFase listaDocumento: type: array items: type: object allOf: – #/definitions/documentoRec description: Lista de Documento listaCliente: type: array items: type: object allOf: – #/definitions/clienteRec description: Lista de Cliente listaClienteDocumento: type: array items: type: object allOf: – #/definitions/clienteDocumentoRec description: Lista de Cliente Documento transferirAcoes: type: boolean description: Define se as novas movimentações e novos documentos devem ser inclusos nos trackings gerados em casos de Trackings Transferidos. default: false responses: 200: description: Ok schema: type: object required: – ok properties: codigoTracking: type: string description: Código do tracking gerado codigoTrackingTransferido: type: string description: Código do tracking transferido idSituacao: type: integer format: int64 description: Situacao idRetorno: type: integer format: int64 description: Chave do Retorno dsRetorno: type: string description: Descrição do Retorno dsUsuario: type: string description: Usuario dtInclusao: type: string format: date-time description: Data de Inclusão linkTracking: type: string description: Link para visualizar os dados do tracking msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/alteraTrackingSituacao: post: description: alteração da situação do tracking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoTracking – situacao properties: codigoTracking: type: string description: Código do Tracking situacao: type: object allOf: – #/definitions/situacaoRec description: Nova situação do tracking responses: 200: description: Ok schema: type: object required: – ok properties: msgErro: type: string description: Caso ocorra erro retorna a mensagem ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/cancelaTrackingFase: post: description: cancela a fase executada do tracking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoTracking: type: string description: Código do Tracking fase: type: object allOf: – #/definitions/faseRec description: Fase a ser deletada codigoExterno: type: integer format: int64 description: Código externo para controle da fase default: 0 transferirAcoes: type: boolean description: Define se as novas movimentações e novos documentos devem ser inclusos nos trackings gerados em casos de Trackings Transferidos. default: false responses: 200: description: Ok schema: type: object required: – ok properties: msgErro: type: string description: Caso ocorra erro retorna a mensagem ok: type: boolean description: Caso ocorra erro retorna false 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/externalTenantBuscaDocumentosEEnvolvidos: post: description: Obtém lista de documentos e envolvidos de um tracking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – trackingId properties: trackingId: type: string description: Uuid tracking responses: 200: description: Ok schema: type: object required: – documentosEEnvolvidos – ok properties: documentosEEnvolvidos: type: array items: type: object allOf: – #/definitions/documentosEEnvolvidosRec minimum: 1 description: Documentos e envolvidos msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false default: description: Error response schema: #/definitions/genericError /tck/actions/externalBuscaPermissoesUsuario: post: description: Busca propriedades dos papéis para login externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ocultarDataPrevisaoEntregaConsultaExterna properties: ocultarDataPrevisaoEntregaConsultaExterna: type: boolean description: default: description: Error response schema: #/definitions/genericError /tck/actions/externalTenantConsultaTracking: post: description: Recebe parametros para realizar um filtro de um external tenant e retornar uma Lista de trackings tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoTracking: type: string description: Código do Tracking inscricaoFiscal: type: string description: Cliente relacionado ao tracking dataInicio: type: string format: date-time description: Data Inicial a ser filtrado dataFim: type: string format: date-time description: Data Final a ser filtrado situacao: type: object allOf: – #/definitions/situacao description: Situação do tracking documento: type: string description: Documento serie: type: string description: Serie do documento tipoDocumento: type: object allOf: – #/definitions/tipoDocumento description: Tipo de Documento identificadorCliente: type: string description: Cliente relacionado ao documento somenteFasesExecutadas: type: boolean description: Retornar somente as fases executas default: true pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – listaTracking – ok – totalRegistros properties: listaTracking: type: array items: type: object allOf: – #/definitions/trackingCompletoRec minimum: 1 description: Lista de trackings filtrados msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false totalRegistros: type: integer format: int64 description: Total de registros encontrados default: description: Error response schema: #/definitions/genericError /tck/actions/consultaTipoDocumento: post: description: Consulta os tipos de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: descricao: type: string description: Informa a descrição do Tipo de Documento que deseja buscar responses: 200: description: Ok schema: type: object required: – tipoDocumento – ok properties: tipoDocumento: type: array items: type: object allOf: – #/definitions/tipoDocumento minimum: 1 description: Retorna o tipo de documento encontrada msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false default: description: Error response schema: #/definitions/genericError /tck/actions/consultaSituacao: post: description: Consulta as situações do tracking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: descricao: type: string description: Informa a descrição do Tipo de Documento que deseja buscar responses: 200: description: Ok schema: type: object required: – situacao – ok properties: situacao: type: array items: type: object allOf: – #/definitions/situacao minimum: 1 description: Retorna as situações encontradas msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false default: description: Error response schema: #/definitions/genericError /tck/actions/externalConsultaTrackingFase: post: description: Consulta as fases do tracking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoTracking properties: codigoTracking: type: string description: Código de Rastreio responses: 200: description: Ok schema: type: object required: – trackingFase – ok properties: trackingFase: type: array items: type: object allOf: – #/definitions/trackingFaseRec minimum: 1 description: Retorna as fases relacionadas ao tracking msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false default: description: Error response schema: #/definitions/genericError /tck/actions/externalConsultaTrackingDocumento: post: description: Consulta os documentos do tracking tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoTracking properties: codigoTracking: type: string description: Código de Rastreio responses: 200: description: Ok schema: type: object required: – trackingDocumento – ok properties: trackingDocumento: type: array items: type: object allOf: – #/definitions/trackingDocumentoRec minimum: 1 description: Retorna as fases relacionadas ao tracking msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false default: description: Error response schema: #/definitions/genericError /tck/actions/validaCliente: post: description: Valida se o cliente existe tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: identificadorCliente: type: string description: Identificador do cliente a ser validado responses: 200: description: Ok schema: type: object required: – ok properties: msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false default: description: Error response schema: #/definitions/genericError /tck/actions/atualizaOrdenacaoTipoDocumento: post: description: Atualiza ordenação dos tipos de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tiposDocumento properties: tiposDocumento: type: array items: type: object allOf: – #/definitions/tipoDocumentoInputRec minimum: 1 description: Tipos de documentos responses: 200: description: Ok schema: type: object required: – tiposDocumentos properties: tiposDocumentos: type: array items: type: object allOf: – #/definitions/tipoDocumento minimum: 1 description: Lista de tipos de documento e suas respectivas novas ordenações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/transfereTracking: post: description: Atualiza ordenação dos tipos de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoTracking – listaDocumento – listaClienteDocumento properties: codigoTracking: type: string description: Código do tracking codigoPlano: type: integer format: int64 description: Código do plano dataPrevisaoEntrega: type: string format: date-time description: Data de previsão de entrega listaDocumento: type: array items: type: object allOf: – #/definitions/documentoRec minimum: 1 description: Lista de documentos listaCliente: type: array items: type: object allOf: – #/definitions/clienteRec description: Lista de clientes listaClienteDocumento: type: array items: type: object allOf: – #/definitions/clienteDocumentoRec minimum: 1 description: Lista de Clientes Documentos responses: 200: description: Ok schema: type: object properties: codigoTracking: type: string description: Código do tracking gerado codigoTrackingTransferido: type: string description: Código do tracking transferido idSituacao: type: integer format: int64 description: Situacao idRetorno: type: integer format: int64 description: Chave do Retorno dsRetorno: type: string description: Descrição do Retorno dsUsuario: type: string description: Usuario dtInclusao: type: string format: date-time description: Data de Inclusão linkTracking: type: string description: Link para visualizar os dados do tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importEmpresa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importSituacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importPapel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importCliente: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importTipoDocumento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importTipoCliente: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importClientePapel: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importDocumento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importPlano: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importChatbot: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importChatbotFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importNotificacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importFase: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importPlanoFase: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importClienteDocumento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importTracking: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importTrackingSituacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importTrackingCliente: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importTrackingDocumento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importTrackingFase: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importFaleconosco: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/actions/importFaleconoscoFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/events/importEmpresaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportEmpresaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importSituacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportSituacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importPapelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportPapelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importClienteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportClienteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importTipoDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportTipoDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importTipoClienteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportTipoClienteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importClientePapelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportClientePapelEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importPlanoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportPlanoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importChatbotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportChatbotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importChatbotFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportChatbotFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importNotificacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportNotificacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importFaseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportFaseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importPlanoFaseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportPlanoFaseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importClienteDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportClienteDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importTrackingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportTrackingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importTrackingSituacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportTrackingSituacaoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importTrackingClienteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportTrackingClienteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importTrackingDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportTrackingDocumentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importTrackingFaseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportTrackingFaseEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importFaleconoscoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportFaleconoscoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/importFaleconoscoFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/events/exportFaleconoscoFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tck/entities/empresa: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/empresa/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/empresa responses: 200: description: Ok schema: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/empresa/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/empresa responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/filial: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/filial/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/filial responses: 200: description: Ok schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/filial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/situacao: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situacao responses: 200: description: The created resource schema: #/definitions/situacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/situacao responses: 200: description: The created resource schema: #/definitions/situacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/situacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/situacao/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/situacao responses: 200: description: Ok schema: #/definitions/situacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/situacao responses: 200: description: Ok schema: #/definitions/situacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/situacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/situacao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/situacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/papel: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/papel responses: 200: description: The created resource schema: #/definitions/papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/papel responses: 200: description: The created resource schema: #/definitions/papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/papel/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/papel responses: 200: description: Ok schema: #/definitions/papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/papel responses: 200: description: Ok schema: #/definitions/papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/papel/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/papel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/cliente: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cliente responses: 200: description: The created resource schema: #/definitions/cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cliente responses: 200: description: The created resource schema: #/definitions/cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/cliente/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cliente responses: 200: description: Ok schema: #/definitions/cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cliente responses: 200: description: Ok schema: #/definitions/cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/cliente/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cliente responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tipoDocumento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tipoDocumento responses: 200: description: The created resource schema: #/definitions/tipoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tipoDocumento responses: 200: description: The created resource schema: #/definitions/tipoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tipoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tipoDocumento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tipoDocumento responses: 200: description: Ok schema: #/definitions/tipoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tipoDocumento responses: 200: description: Ok schema: #/definitions/tipoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tipoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tipoDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tipoCliente: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tipoCliente responses: 200: description: The created resource schema: #/definitions/tipoCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tipoCliente responses: 200: description: The created resource schema: #/definitions/tipoCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tipoCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tipoCliente/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tipoCliente responses: 200: description: Ok schema: #/definitions/tipoCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tipoCliente responses: 200: description: Ok schema: #/definitions/tipoCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tipoCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tipoCliente/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoCliente responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/clientePapel: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/clientePapel responses: 200: description: The created resource schema: #/definitions/clientePapel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/clientePapel responses: 200: description: The created resource schema: #/definitions/clientePapel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/clientePapel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/clientePapel/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clientePapel responses: 200: description: Ok schema: #/definitions/clientePapel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clientePapel responses: 200: description: Ok schema: #/definitions/clientePapel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/clientePapel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/clientePapel/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clientePapel responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/documento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documento responses: 200: description: The created resource schema: #/definitions/documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/documento responses: 200: description: The created resource schema: #/definitions/documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/documento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documento responses: 200: description: Ok schema: #/definitions/documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documento responses: 200: description: Ok schema: #/definitions/documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/documento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/plano: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/plano responses: 200: description: The created resource schema: #/definitions/plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/plano responses: 200: description: The created resource schema: #/definitions/plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/plano/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/plano responses: 200: description: Ok schema: #/definitions/plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/plano responses: 200: description: Ok schema: #/definitions/plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/plano 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/plano/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/plano responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/chatbot: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/chatbot responses: 200: description: The created resource schema: #/definitions/chatbot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/chatbot responses: 200: description: The created resource schema: #/definitions/chatbot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/chatbot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/chatbot/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/chatbot responses: 200: description: Ok schema: #/definitions/chatbot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/chatbot responses: 200: description: Ok schema: #/definitions/chatbot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/chatbot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/chatbot/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/chatbot responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/chatbotFilial: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/chatbotFilial responses: 200: description: The created resource schema: #/definitions/chatbotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/chatbotFilial responses: 200: description: The created resource schema: #/definitions/chatbotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/chatbotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/chatbotFilial/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/chatbotFilial responses: 200: description: Ok schema: #/definitions/chatbotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/chatbotFilial responses: 200: description: Ok schema: #/definitions/chatbotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/chatbotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/chatbotFilial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/chatbotFilial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/notificacao: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notificacao responses: 200: description: The created resource schema: #/definitions/notificacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notificacao responses: 200: description: The created resource schema: #/definitions/notificacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/notificacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/notificacao/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/notificacao responses: 200: description: Ok schema: #/definitions/notificacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/notificacao responses: 200: description: Ok schema: #/definitions/notificacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/notificacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/notificacao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notificacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/fase: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fase responses: 200: description: The created resource schema: #/definitions/fase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fase responses: 200: description: The created resource schema: #/definitions/fase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/fase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/fase/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fase responses: 200: description: Ok schema: #/definitions/fase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fase responses: 200: description: Ok schema: #/definitions/fase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/fase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/fase/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fase responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/planoFase: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/planoFase responses: 200: description: The created resource schema: #/definitions/planoFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/planoFase responses: 200: description: The created resource schema: #/definitions/planoFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/planoFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/planoFase/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/planoFase responses: 200: description: Ok schema: #/definitions/planoFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/planoFase responses: 200: description: Ok schema: #/definitions/planoFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/planoFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/planoFase/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/planoFase responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/clienteDocumento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/clienteDocumento responses: 200: description: The created resource schema: #/definitions/clienteDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/clienteDocumento responses: 200: description: The created resource schema: #/definitions/clienteDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/clienteDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/clienteDocumento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clienteDocumento responses: 200: description: Ok schema: #/definitions/clienteDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clienteDocumento responses: 200: description: Ok schema: #/definitions/clienteDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/clienteDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/clienteDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clienteDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tracking: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tracking responses: 200: description: The created resource schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tracking responses: 200: description: The created resource schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tracking/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tracking responses: 200: description: Ok schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tracking responses: 200: description: Ok schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/tracking/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tracking responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingSituacao: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingSituacao responses: 200: description: The created resource schema: #/definitions/trackingSituacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingSituacao responses: 200: description: The created resource schema: #/definitions/trackingSituacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/trackingSituacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingSituacao/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingSituacao responses: 200: description: Ok schema: #/definitions/trackingSituacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingSituacao responses: 200: description: Ok schema: #/definitions/trackingSituacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/trackingSituacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingSituacao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/trackingSituacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingCliente: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingCliente responses: 200: description: The created resource schema: #/definitions/trackingCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingCliente responses: 200: description: The created resource schema: #/definitions/trackingCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/trackingCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingCliente/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingCliente responses: 200: description: Ok schema: #/definitions/trackingCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingCliente responses: 200: description: Ok schema: #/definitions/trackingCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/trackingCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingCliente/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/trackingCliente responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingDocumento: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingDocumento responses: 200: description: The created resource schema: #/definitions/trackingDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingDocumento responses: 200: description: The created resource schema: #/definitions/trackingDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/trackingDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingDocumento/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingDocumento responses: 200: description: Ok schema: #/definitions/trackingDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingDocumento responses: 200: description: Ok schema: #/definitions/trackingDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/trackingDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/trackingDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingFase: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingFase responses: 200: description: The created resource schema: #/definitions/trackingFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/trackingFase responses: 200: description: The created resource schema: #/definitions/trackingFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/trackingFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingFase/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingFase responses: 200: description: Ok schema: #/definitions/trackingFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/trackingFase responses: 200: description: Ok schema: #/definitions/trackingFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/trackingFase 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/trackingFase/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/trackingFase responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/faleconosco: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faleconosco responses: 200: description: The created resource schema: #/definitions/faleconosco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faleconosco responses: 200: description: The created resource schema: #/definitions/faleconosco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/faleconosco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/faleconosco/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faleconosco responses: 200: description: Ok schema: #/definitions/faleconosco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faleconosco responses: 200: description: Ok schema: #/definitions/faleconosco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faleconosco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/faleconosco/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/faleconosco responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/faleconoscoFilial: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faleconoscoFilial responses: 200: description: The created resource schema: #/definitions/faleconoscoFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/faleconoscoFilial responses: 200: description: The created resource schema: #/definitions/faleconoscoFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/faleconoscoFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/faleconoscoFilial/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faleconoscoFilial responses: 200: description: Ok schema: #/definitions/faleconoscoFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/faleconoscoFilial responses: 200: description: Ok schema: #/definitions/faleconoscoFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/faleconoscoFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tck/entities/faleconoscoFilial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/faleconoscoFilial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: enumTipoArquivo: description: Tipos de arquivos disponíveis, conforme extensões type: string enum: – XML – PDF – PNG – JPG – JPEG – TXT – DOC – DOCX – XLS – XLT – XLSX – CSV – ZIP – ComprovantePDF upDown: description: Up or down type: string enum: – UP – DOWN EnumTipoInscricao: description: Tipo Inscrição CPF/CNPJ type: string enum: – CPF – CNPJ enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumFiltraEnvArquivo: description: Filtro para validar a existencia do arquivo a ser enviado type: string enum: – IdBlobService – Nome enumTpNotificacao: description: Enumeração para o tipo de notificação type: string enum: – CORPO – CABECALHO – RODAPE enumTpEnvChatbot: description: Enumeração para o tipo de envio chatbot type: string enum: – PHONE_MOBILE enumFornecChatbot: description: Enumeração dos fornecedores responsaveis pelo envio chatbot type: string enum: – SNAPBOT userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recArquivo: description: Arquivos salvos no blobservice type: object required: – idBlobServiceFile – tipoArquivo properties: dataDownload: type: string format: date-time description: Data e hora da primeira baixa do arquivo idBlobServiceFile: type: string description: Identificador Blobservice tipoArquivo: type: string allOf: – #/definitions/enumTipoArquivo description: Tipo do arquivo nome: type: string description: Nome do arquivo recRetArquivoBlobService: description: Informações de retorno do arquivo sobre o blobservice type: object required: – idBlobServiceFile – urlAcesso – nomeArquivo – versao – dataLimiteArquivoDisponivel – arquivoExiste – ok – msgErro properties: idBlobServiceFile: type: string description: id unico do arquivo no serviço urlAcesso: type: string description: URL para realizar o upload/download do arquivo nomeArquivo: type: string description: nome do arquivo versao: type: string description: versão do arquivo criado dataLimiteArquivoDisponivel: type: string format: date-time description: Data limite para acessar realizar o download arquivoExiste: type: boolean description: Indica se o arquivo já existe ok: type: boolean description: Sucesso na operação msgErro: type: string description: Mensagem de erro, caso ocorra recPageRequest: description: Define a paginação da query type: object required: – offset – size properties: offset: type: integer format: int64 description: Número da página minimum: 0 size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recFaleconosco: description: Dados referente ao fale conosco type: object required: – id – mensagem properties: id: type: string description: UUID da mensagem mensagem: type: string description: Mensagem whatsapp: type: string description: Contato whatsapp email: type: string description: Email recTrackingNativo: description: type: object required: – id – total properties: id: type: string description: total: type: integer format: int64 description: tipoDocumentoInputRec: description: type: object properties: id: type: string description: codigo: type: string description: documentosEEnvolvidosRec: description: Informações do Documento e envolvidos type: object required: – numero properties: numero: type: string description: Número serie: type: string description: Série tipoDocumento: type: object allOf: – #/definitions/tipoDocumentoRec description: Tipo do documento remetente: type: object allOf: – #/definitions/clienteRec description: Remetente do documento destinatario: type: object allOf: – #/definitions/clienteRec description: Destinatario do documento empresaRec: description: Informações da empresa type: object required: – nome properties: nome: type: string description: Nome ativo: type: boolean description: Ativo default: true filialRec: description: Informações da filial type: object required: – nome – cnpj – tipoFilial – empresa properties: nome: type: string description: Nome cnpj: type: string description: CNPJ tipoFilial: type: integer format: int64 description: Tipo da filial ativo: type: boolean description: Ativo default: true empresa: type: object allOf: – #/definitions/empresaRec description: Empresa situacaoRec: description: Informações da situação do Tracking type: object required: – descricao properties: descricao: type: string description: Descrição tipoSituacao: type: integer format: int64 description: Tipo da situação ativo: type: boolean description: Ativo default: true notificacaoRec: description: Informações da notificação type: object required: – descricao – mensagem properties: descricao: type: string description: Descrição mensagem: type: string description: Formato da mensagem mensagemCancelamento: type: string description: Formato da mensagem de cancelamento padrao: type: boolean description: Padrão default: false tipoNotificacao: type: string allOf: – #/definitions/enumTpNotificacao description: Tipo de notificação faseRec: description: Informações da fase type: object required: – codigo properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo default: true enviaWhatsapp: type: boolean description: Envia Whatsapp notificacaoExecucao: type: object allOf: – #/definitions/notificacaoRec description: Notificação enviada ao executar a fase contatosNotificacao: type: array items: type: object allOf: – #/definitions/contatoRec description: Contatos que receberão a notificação mensagemCompleta: type: string description: Mensagem já formatada para envio da notificação planoRec: description: Informações do Plano type: object required: – codigo properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição padrao: type: boolean description: Padrão default: false ativo: type: boolean description: Ativo default: true tipoDocumentoRec: description: Informações do tipo de documento type: object required: – descricao properties: codigo: type: string description: Código descricao: type: string description: Descrição unico: type: boolean description: Único ativo: type: boolean description: Ativo default: true tipoClienteRec: description: Informações do tipo de Cliente type: object required: – descricao properties: codigo: type: string description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo default: true documentoRec: description: Informações do documento type: object required: – numero – serie – identificadorCliente – tipoDocumento properties: numero: type: string description: Número serie: type: string description: Série identificadorCliente: type: string description: Identificador do cliente ativo: type: boolean description: Ativo default: true tipoDocumento: type: object allOf: – #/definitions/tipoDocumentoRec description: Tipo do documento clienteRec: description: Informações do cliente type: object required: – nome – inscricaoFiscal – tipoInscricaoFiscal properties: nome: type: string maxLength: 255 description: Nome inscricaoFiscal: type: string maxLength: 19 description: Inscrição fiscal tipoInscricaoFiscal: type: integer format: int64 description: Tipo da inscrição fiscal ativo: type: boolean description: Ativo default: true clienteDocumentoRec: description: Informações da relação entre Cliente e Documento type: object required: – cliente – documento properties: cliente: type: object allOf: – #/definitions/clienteRec description: Cliente documento: type: object allOf: – #/definitions/documentoRec description: Documento tipoClienteRec: type: object allOf: – #/definitions/tipoClienteRec description: Tipo do cliente tipoCliente: type: integer format: int64 description: Código do Tipo do cliente ativo: type: boolean description: Ativo default: true trackingRec: description: Informações do tracking type: object required: – id – codigo properties: id: type: string description: ID codigo: type: string description: Código observacao: type: string description: Observações dataPrevisaoEntrega: type: string format: date-time description: Data de previsão de entrega dataEntrega: type: string format: date-time description: Data de entrega dataInicio: type: string format: date-time description: Data de inicio do tracking ativo: type: boolean description: Ativo default: true plano: type: object allOf: – #/definitions/planoRec description: Plano situacao: type: object allOf: – #/definitions/situacaoRec description: Situação filial: type: object allOf: – #/definitions/filialRec description: Filial inscricaoFiscal: type: string description: Cliente relacionado ao tracking documento: type: string description: Documento serie: type: string description: Serie do documento identificadorCliente: type: string description: Cliente relacionado ao documento nomeCliente: type: string description: Nome do cliente relacionado ao documento tipoDocumento: type: object allOf: – #/definitions/tipoDocumentoRec description: Tipo de Documento transferido: type: boolean description: Transferido default: false recEnvArquivoBlobService: description: Informações sobre o acesso ao arquivo type: object required: – chave – tipoArquivo properties: chave: type: string description: Chave do arquivo tipoArquivo: type: string allOf: – #/definitions/enumTipoArquivo description: Extensão do arquivo filtraEnvArquivo: type: string allOf: – #/definitions/enumFiltraEnvArquivo description: Filtro a ser utilizado para validar a existencia do arquivo trackingCompletoRec: description: Todas as informações do tracking type: object required: – tracking – listaTrackingFase – listaTrackingDocumento properties: tracking: type: object allOf: – #/definitions/trackingRec description: tracking listaTrackingFase: type: array items: type: object allOf: – #/definitions/trackingFaseRec minimum: 1 description: Lista de TrackingFase listaTrackingDocumento: type: array items: type: object allOf: – #/definitions/trackingDocumentoRec minimum: 1 description: Lista de Documento trackingCompletoCsvRec: description: Todas as informações do tracking necessárias para exportação CSV type: object required: – tracking – listaTrackingFase – listaTrackingDocumentoEEnvolvidos properties: tracking: type: object allOf: – #/definitions/trackingRec description: tracking listaTrackingFase: type: array items: type: object allOf: – #/definitions/trackingFaseRec minimum: 1 description: Lista de TrackingFase listaTrackingDocumentoEEnvolvidos: type: array items: type: object allOf: – #/definitions/documentosEEnvolvidosRec minimum: 1 description: Lista de Documento trackingFaseRec: description: Informações da fase do tracking type: object required: – fase properties: executada: type: boolean description: Executada default: false sequencia: type: integer format: int64 description: Sequencia dataExecucao: type: string format: date-time description: Data execução previsaoExecucao: type: string format: date-time description: Data previsão observacao: type: string description: Observação contato: type: string description: Contato encerrarTracking: type: boolean description: Encerrar o Tracking default: false fase: type: object allOf: – #/definitions/faseRec description: Fase codigoExterno: type: integer format: int64 description: Código externo para controle da fase default: 0 trackingDocumentoRec: description: Informações do documento do tracking type: object required: – documento properties: ativo: type: boolean description: Ativo default: true documento: type: object allOf: – #/definitions/documentoRec description: Documento contatoRec: description: Informações do contato type: object required: – telefone properties: nome: type: string description: Nome telefone: type: string description: Telefone enderecoCompleto: type: string description: Endereço completo LinkRec: description: Informações do link type: object required: – descricao – link properties: descricao: type: string description: Descrição do link link: type: string description: hyperlink consultaTrackingInputRec: description: Filtros para a consulta do tracking type: object properties: inscricaoFiscal: type: string description: Cliente relacionado ao tracking codigoTracking: type: string description: Código do Tracking a ser filtrado dataInicio: type: string format: date-time description: Data Inicial a ser filtrado dataFim: type: string format: date-time description: Data Final a ser filtrado situacao: type: object allOf: – #/definitions/situacao description: Situação a ser filtrada documento: type: string description: Documento a ser filtrado serie: type: string description: Serie do documento a ser filtrado identificadorCliente: type: string description: Identificador do cliente a ser filtrado tipoDocumento: type: object allOf: – #/definitions/tipoDocumento description: Tipo de Documento a ser filtrado somenteFasesExecutadas: type: boolean description: Retornar somente as fases executas default: true pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados consultaTrackingOutputRec: description: Informações de retorno da consulta do tracking type: object required: – listaTracking – totalRegistros properties: listaTracking: type: array items: type: object allOf: – #/definitions/trackingCompletoRec minimum: 1 description: Lista de trackings filtrados totalRegistros: type: integer format: int64 description: Total de registros encontrados recTotalizadorFase: description: type: object required: – fase – quantidadeTrackings properties: fase: type: object allOf: – #/definitions/fase description: quantidadeTrackings: type: integer format: int64 description: recEntidadeRelacionada: description: Record genérico com id da entidade relacionada type: object required: – id properties: id: type: string description: Identificador único filialInputRec: description: Filial Uk type: object properties: id: type: string description: Identificador único cnpj: type: string description: CNPJ faseInputRec: description: Fase Uk type: object properties: id: type: string description: Identificador único codigo: type: integer format: int64 description: código empresa: description: Empresas type: object required: – nome properties: id: type: string format: uuid description: Chave da tabela nome: type: string description: Nome ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filial: description: Filiais type: object required: – nome – cnpj – tipoFilial – empresa properties: id: type: string format: uuid description: Chave da tabela nome: type: string description: Nome cnpj: type: string description: CNPJ tipoFilial: type: integer format: int64 description: Tipo da filial ativo: type: boolean description: Ativo default: true empresa: type: object allOf: – #/definitions/empresa description: Empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: situacao: description: Situações do Tracking type: object required: – descricao – tipoSituacao properties: id: type: string format: uuid description: Chave da tabela descricao: type: string description: Descrição tipoSituacao: type: integer format: int64 description: Tipo da situação ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: papel: description: Definição de Papel dos clientes type: object properties: id: type: string format: uuid description: Chave da tabela createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cliente: description: Clientes type: object required: – nome – inscricaoFiscal – tipoInscricaoFiscal properties: id: type: string format: uuid description: Chave da tabela nome: type: string description: Nome inscricaoFiscal: type: string description: Inscrição fiscal tipoInscricaoFiscal: type: string allOf: – #/definitions/EnumTipoInscricao description: Tipo da inscrição fiscal ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoDocumento: description: Tipos de Documentos type: object required: – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: string description: Código descricao: type: string description: Descrição unico: type: boolean description: Único por tracking ativo: type: boolean description: Ativo default: true ordenacaoExibeTracking: type: integer format: int64 description: Ordenação de exibição createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoCliente: description: Tipos de Cliente type: object required: – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: string description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: clientePapel: description: Relação entre Clientes e Papeis type: object required: – cliente – papel properties: id: type: string format: uuid description: Chave da tabela cliente: type: object allOf: – #/definitions/cliente description: Cliente papel: type: object allOf: – #/definitions/papel description: Papel createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documento: description: Documentos type: object required: – numero properties: id: type: string format: uuid description: Chave da tabela numero: type: string description: Número serie: type: string description: Série identificadorCliente: type: string description: Identificador do cliente ativo: type: boolean description: Ativo default: true tipoDocumento: type: object allOf: – #/definitions/tipoDocumento description: Tipo do documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: plano: description: Planos type: object required: – codigo – descricao – padrao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição padrao: type: boolean description: Padrão ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: chatbot: description: Informações do chatbot para envio de mensagem type: object required: – descricao – fornecedor – webserviceEnvio properties: id: type: string format: uuid description: Chave da tabela idBot: type: integer format: int64 description: Identificação do bot descricao: type: string description: Descrição tipoEnvio: type: string allOf: – #/definitions/enumTpEnvChatbot description: Tipo de envio fornecedor: type: string description: Fornecedor envio da notificação webserviceEnvio: type: string description: Webservice de envio autorizacao: type: string description: Código de autorização createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: chatbotFilial: description: Vinculação entre o chatbot e a filial type: object required: – chatbot – filial properties: id: type: string format: uuid description: Chave da tabela chatbot: type: object allOf: – #/definitions/chatbot description: Chatbot filial: type: object allOf: – #/definitions/filial description: Filial dataCustom: type: string description: Parâmetro Data_Custom createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notificacao: description: Notificação type: object required: – descricao – mensagem – padrao – tipoNotificacao properties: id: type: string format: uuid description: Chave da tabela descricao: type: string description: Descrição mensagem: type: string description: Formato da mensagem mensagemCancelamento: type: string description: Formato da mensagem de cancelamento padrao: type: boolean description: Padrão tipoNotificacao: type: string allOf: – #/definitions/enumTpNotificacao description: Tipo de notificação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: fase: description: Fases type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo default: true enviaWhatsapp: type: boolean description: Envia Whatsapp notificacaoExecucao: type: object allOf: – #/definitions/notificacao description: Notificação enviada ao executar a fase createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: planoFase: description: Relação entre Planos e Fases type: object required: – sequencia – plano – fase properties: id: type: string format: uuid description: Chave da tabela sequencia: type: integer format: int64 description: Sequência plano: type: object allOf: – #/definitions/plano description: Plano fase: type: object allOf: – #/definitions/fase description: Fase createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: clienteDocumento: description: Relação entre Cliente e Documento type: object required: – cliente – documento – tipoCliente properties: id: type: string format: uuid description: Chave da tabela cliente: type: object allOf: – #/definitions/cliente description: Cliente documento: type: object allOf: – #/definitions/documento description: Documento tipoCliente: type: object allOf: – #/definitions/tipoCliente description: Tipo do cliente ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tracking: description: Tracking type: object properties: id: type: string format: uuid description: Chave da tabela codigo: type: string description: Código observacao: type: string description: Observação dataPrevisaoEntrega: type: string format: date-time description: Data de previsão de entrega dataEntrega: type: string format: date-time description: Data de entrega dataInicio: type: string format: date-time description: Data de inicio do tracking ativo: type: boolean description: Ativo default: true plano: type: object allOf: – #/definitions/plano description: Plano situacao: type: object allOf: – #/definitions/situacao description: Situação filial: type: object allOf: – #/definitions/filial description: Filial trackingTransferido: type: object allOf: – #/definitions/tracking description: Tracking transferido transferido: type: boolean description: Transferido default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: trackingSituacao: description: Relação entre Tracking e Situação type: object required: – situacao – tracking properties: id: type: string format: uuid description: Chave situacao: type: object allOf: – #/definitions/situacao description: Situação tracking: type: object allOf: – #/definitions/tracking description: Tracking createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: trackingCliente: description: Relação entre Tracking e Cliente type: object required: – tracking – cliente properties: id: type: string format: uuid description: Chave ativo: type: boolean description: Ativo default: true tracking: type: object allOf: – #/definitions/tracking description: Tracking cliente: type: object allOf: – #/definitions/cliente description: CLiente createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: trackingDocumento: description: Relação entre Tracking e Documento type: object required: – tracking – documento properties: id: type: string format: uuid description: Chave ativo: type: boolean description: Ativo default: true tracking: type: object allOf: – #/definitions/tracking description: Tracking documento: type: object allOf: – #/definitions/documento description: Documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: trackingFase: description: Relação entre Tracking e Fase type: object required: – executada – sequencia – fase – tracking properties: id: type: string format: uuid description: Chave executada: type: boolean description: Executada sequencia: type: integer format: int64 description: Sequencia dataExecucao: type: string format: date-time description: Data execução previsaoExecucao: type: string format: date-time description: Data previsão observacao: type: string description: Observação contato: type: string description: Contato fase: type: object allOf: – #/definitions/fase description: Fase tracking: type: object allOf: – #/definitions/tracking description: Tracking codigoExterno: type: integer format: int64 description: Código externo default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: faleconosco: description: Tabela FaleConosco type: object required: – mensagem – padrao properties: id: type: string format: uuid description: Chave da tabela mensagem: type: string description: Mensagem whatsapp: type: string description: whatsapp email: type: string description: Email padrao: type: boolean description: padrao createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: faleconoscoFilial: description: Relação entre FaleConosco e Filial type: object required: – faleconosco – filial properties: id: type: string format: uuid description: Chave da tabela faleconosco: type: object allOf: – #/definitions/faleconosco description: Identificador da tabela FaleConosco filial: type: object allOf: – #/definitions/filial description: Identificador da Filial createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação