Gestão de Pátio (yms)

agenda

22 views 04/08/2020 05/11/2020 integrador 0

2.0info: 6.1.1 agenda description: Serviço de Agendamento x-senior-domain: Controle de Pátio x-senior-domain-path: yms x-senior-service-path: agenda contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/ymssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /agenda/queries/getAgendasPorPeriodo: post: description: Retorna os agendamentos em um determinado período. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataInicio – dataFim properties: dataInicio: type: string format: date-time description: Data inicial do período dataFim: type: string format: date-time description: Data final do período responses: 200: description: Ok schema: type: object required: – agendas properties: agendas: type: array items: type: object allOf: – #/definitions/agenda minimum: 1 description: Lista de agendamentos encontrados no período default: description: Error response schema: #/definitions/genericError get: description: Retorna os agendamentos em um determinado período. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataInicio description: Data inicial do período in: query required: true type: string format: date-time – name: dataFim description: Data final do período in: query required: true type: string format: date-time responses: 200: description: Ok schema: type: object required: – agendas properties: agendas: type: array items: type: object allOf: – #/definitions/agenda minimum: 1 description: Lista de agendamentos encontrados no período default: description: Error response schema: #/definitions/genericError /agenda/queries/getExisteAgendaAgendadoExecucaoComTipoAgendamento: post: description: Retorna Verdadeiro/Falso dado um tipo de agendamento que possua um Agendamento vinculado cujo estado seja Agendado ou em Execução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoAgendamento properties: tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento para consultar Agendamentos Agendados ou em Execução responses: 200: description: Ok schema: type: object required: – possuiAgendamento properties: possuiAgendamento: type: boolean description: Retorno true caso haja Agendamento Agendado ou em Execução, caso contrário retorna false default: description: Error response schema: #/definitions/genericError /agenda/queries/isClienteExterno: post: description: Retorna se o acesso é realizado por um cliente externo para decisoes de front-end tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isClienteExterno properties: isClienteExterno: type: boolean description: Informar se é cliente externo parceiro: type: object allOf: – #/definitions/externalTenant description: Se existir, retorna o parceiro default: description: Error response schema: #/definitions/genericError get: description: Retorna se o acesso é realizado por um cliente externo para decisoes de front-end tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isClienteExterno properties: isClienteExterno: type: boolean description: Informar se é cliente externo parceiro: type: object allOf: – #/definitions/externalTenant description: Se existir, retorna o parceiro default: description: Error response schema: #/definitions/genericError /agenda/queries/horarioOperacao: post: description: Busca uma lista de horários de operação da planta pelo tipo de agendamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoAgendamentoId – data – horaOffset – plantaId properties: tipoAgendamentoId: type: string description: ID ou código do tipo de agendamento data: type: string format: date description: A data em que se deseja verificar os horários de operação horaOffset: type: integer format: int64 description: Time zone da hora de agendamento em relação a UTC. Esse valor varia de -12 a 14 minimum: -12 maximum: 14 plantaId: type: string description: ID ou CNPJ da planta responses: 200: description: Ok schema: type: object required: – horarios properties: horarios: type: array items: type: object allOf: – #/definitions/horarioDisponivel minimum: 1 description: Lista de horários de funcionamento, com intervalos definidos pelo tipo de agendamento e suas respectivas quantidades de agendamentos disponíveis default: description: Error response schema: #/definitions/genericError get: description: Busca uma lista de horários de operação da planta pelo tipo de agendamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tipoAgendamentoId description: ID ou código do tipo de agendamento in: query required: true type: string – name: data description: A data em que se deseja verificar os horários de operação in: query required: true type: string format: date – name: horaOffset description: Time zone da hora de agendamento em relação a UTC. Esse valor varia de -12 a 14 in: query required: true type: integer format: int64 – name: plantaId description: ID ou CNPJ da planta in: query required: true type: string responses: 200: description: Ok schema: type: object required: – horarios properties: horarios: type: array items: type: object allOf: – #/definitions/horarioDisponivel minimum: 1 description: Lista de horários de funcionamento, com intervalos definidos pelo tipo de agendamento e suas respectivas quantidades de agendamentos disponíveis default: description: Error response schema: #/definitions/genericError /agenda/queries/buscaMediaExecucaoCircuito: post: description: Busca a média de tempo das execuções dos circuitos em segundos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entidadeId properties: entidadeId: type: string description: Id do Circuito ou do Tipo de Agendamento composicaoVeiculoId: type: string description: ID da composição de veículo responses: 200: description: Ok schema: type: object required: – mediaExecucaoCircuito properties: mediaExecucaoCircuito: type: object allOf: – #/definitions/mediaExecucaoCircuito description: Média e percentis das execuções de circuitos default: description: Error response schema: #/definitions/genericError get: description: Busca a média de tempo das execuções dos circuitos em segundos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entidadeId description: Id do Circuito ou do Tipo de Agendamento in: query required: true type: string – name: composicaoVeiculoId description: ID da composição de veículo in: query type: string responses: 200: description: Ok schema: type: object required: – mediaExecucaoCircuito properties: mediaExecucaoCircuito: type: object allOf: – #/definitions/mediaExecucaoCircuito description: Média e percentis das execuções de circuitos default: description: Error response schema: #/definitions/genericError /agenda/queries/buscaMediaTipoAgendamento: post: description: Busca a média de execução do circuito pelo tipo de agendamento especificado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoAgendamentoId – plantaId properties: tipoAgendamentoId: type: string description: Id do tipo de agendamento plantaId: type: string description: Id da planta ao qual os circuitos pertence responses: 200: description: Ok schema: type: object required: – mediaPorTipoAgendamento – mediaPorCicuito – mediaPorComposicaoVeiculo properties: mediaPorTipoAgendamento: type: object allOf: – #/definitions/mediaExecucaoCircuito description: Média calculada pelo tipo de agendamento mediaPorCicuito: type: array items: type: object allOf: – #/definitions/mediaPorCircuito minimum: 1 description: Médias calculadas pelos circuitos relacionados ao tipo de agendamento mediaPorComposicaoVeiculo: type: array items: type: object allOf: – #/definitions/mediaPorComposicaoVeiculo minimum: 1 description: Médias calculadas pelos tipos de veículos relacionados aos circuitos executados do tipo de agendamento default: description: Error response schema: #/definitions/genericError get: description: Busca a média de execução do circuito pelo tipo de agendamento especificado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tipoAgendamentoId description: Id do tipo de agendamento in: query required: true type: string – name: plantaId description: Id da planta ao qual os circuitos pertence in: query required: true type: string responses: 200: description: Ok schema: type: object required: – mediaPorTipoAgendamento – mediaPorCicuito – mediaPorComposicaoVeiculo properties: mediaPorTipoAgendamento: type: object allOf: – #/definitions/mediaExecucaoCircuito description: Média calculada pelo tipo de agendamento mediaPorCicuito: type: array items: type: object allOf: – #/definitions/mediaPorCircuito minimum: 1 description: Médias calculadas pelos circuitos relacionados ao tipo de agendamento mediaPorComposicaoVeiculo: type: array items: type: object allOf: – #/definitions/mediaPorComposicaoVeiculo minimum: 1 description: Médias calculadas pelos tipos de veículos relacionados aos circuitos executados do tipo de agendamento default: description: Error response schema: #/definitions/genericError /agenda/queries/obterUrlUploadAnexo: post: description: Cria o local para armazenamento e busca URL para upload do anexo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo properties: nomeAnexo: type: string description: Nome do arquivo anexo responses: 200: description: Ok schema: type: object required: – id – url – nome – versao properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado default: description: Error response schema: #/definitions/genericError get: description: Cria o local para armazenamento e busca URL para upload do anexo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nomeAnexo description: Nome do arquivo anexo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – id – url – nome – versao properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado default: description: Error response schema: #/definitions/genericError /agenda/queries/obterUrlDownloadAnexo: post: description: Obtém a URL para download do anexo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo properties: nomeAnexo: type: string description: Nome do anexo responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do recurso default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL para download do anexo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nomeAnexo description: Nome do anexo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do recurso default: description: Error response schema: #/definitions/genericError /agenda/queries/buscaTenantPorNome: post: description: Obtêm os dados de um tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – tenantNome properties: tenantNome: type: string description: O nome do tenant a ter os dados retornados responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenant default: description: Error response schema: #/definitions/genericError get: description: Obtêm os dados de um tenant tags: – Queries x-senior-visibility: PUBLIC parameters: – name: tenantNome description: O nome do tenant a ter os dados retornados in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/tenant default: description: Error response schema: #/definitions/genericError /agenda/queries/verificaUsuario: post: description: Verifica se o usuário externo está ativo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: E-mail do usuário externo responses: 200: description: Ok schema: type: object required: – ativo properties: ativo: type: boolean description: Retorna se o usuário está ativo ou não default: description: Error response schema: #/definitions/genericError get: description: Verifica se o usuário externo está ativo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: email description: E-mail do usuário externo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ativo properties: ativo: type: boolean description: Retorna se o usuário está ativo ou não default: description: Error response schema: #/definitions/genericError /agenda/queries/buscarTipoAgendamento: post: description: Busca os tipos de agendamento de acordo com o(s) filtro(s) informados(s) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: plantaId: type: string description: Id da planta tipoAtividade: type: string allOf: – #/definitions/tipoAtividadeTipoAgedamento description: Tipo de atividade do agendamento codigo: type: string description: Código do agendamento descricao: type: string description: Descrição do agendamento page: type: integer format: int64 description: Offset para paginação size: type: integer format: int64 description: Quantos itens exibir sortField: type: string description: Campo para ordenação sortOrder: type: integer format: int64 description: Se ordenação é ascendente ou descendente responses: 200: description: Ok schema: type: object required: – tiposAgendamento – totalElements – totalPages properties: tiposAgendamento: type: array items: type: object allOf: – #/definitions/tipoAgendamento minimum: 1 description: Tipos de agendamento vinculados a planta totalElements: type: integer format: int64 description: Total de elementos para paginação totalPages: type: integer format: int64 description: Total de paginas para paginação default: description: Error response schema: #/definitions/genericError /agenda/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/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 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/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /agenda/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: 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportAgenda: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportTipoAgendamento: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportLimiteOperacao: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportExternalTenant: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportExternalUser: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportComposicaoVeiculo: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportMotorista: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportTipoVeiculo: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportVeiculo: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportPlanta: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportEndereco: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportTurno: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportTurnoData: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportMediaExecucaoCircuito: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportCircuito: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportExecucaoCircuito: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/exportHistoricoExecucaoCircuito: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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 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: PUBLIC 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 default: description: Error response schema: #/definitions/genericError /agenda/actions/cadastrarAgendamento: post: description: Cadastra um novo agendamento\n Esta ação é preferencial para cadastrar agendamentos, pois trata com precisão o fuso horário de acordo com o Turno de funcionamento da Planta.\n Observação: para buscar os horários disponíveis da planta utilize a query **horarioOperacao**\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – descricao – tipoAgendamentoId – plantaId – dataEsperada – horaEsperada – horaOffset – status properties: descricao: type: string description: Descrição do agendamento tipoAgendamentoId: type: string description: ID ou código do tipo de agendamento plantaId: type: string description: ID ou CNPJ da planta dataEsperada: type: string format: date description: Data esperada do agendamento horaEsperada: type: string description: Hora esperada do agendamento horaOffset: type: integer format: int64 description: Time zone da hora de agendamento em relação a UTC. Esse valor varia de -12 a 14 minimum: -12 maximum: 14 status: type: string allOf: – #/definitions/statusInicialAgendamento description: Status inicial do agendamento parceiroId: type: string description: ID ou CNPJ do parceiro (Cliente Externo) motoristaId: type: string description: ID ou CPF do motorista composicaoVeiculoId: type: string description: ID da composicao de veículo observacao: type: string description: Observação do agendamento anexos: type: array items: type: object allOf: – #/definitions/anexo description: Links de anexos do agendamento createdByErp: type: boolean description: Indica se a agenda foi criada pelo serviço ERP default: false responses: 200: description: Ok schema: type: object allOf: – #/definitions/agenda default: description: Error response schema: #/definitions/genericError /agenda/actions/cadastrarAgendamentoSimplificado: post: description: Cadastra um novo agendamento de maneira simplificada.\n Esta ação cadastra um agendamento, já colocando seu status como agendado. A data esperada será o momento do cadastro. As validações de turno e limite de operação não serão feitas, por isso é recomendado que utilize esta chamada apenas na chegada do veículo.\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – descricao – tipoAgendamentoId – plantaId properties: descricao: type: string description: Descrição do agendamento tipoAgendamentoId: type: string description: ID ou código do tipo de agendamento plantaId: type: string description: ID ou CNPJ da planta parceiroId: type: string description: ID ou CNPJ do parceiro (Cliente Externo) motoristaId: type: string description: ID ou CPF do motorista composicaoVeiculoId: type: string description: ID da composicao de veículo observacao: type: string description: Observação do agendamento createdByPatio: type: boolean description: Indica se a agenda foi criada pelo serviço patio default: false responses: 200: description: Ok schema: type: object allOf: – #/definitions/agenda default: description: Error response schema: #/definitions/genericError /agenda/actions/cadastrarMultiplosAgendamentos: post: description: Cadastra múltiplos agendamentos a partir de um código agrupador que o identifica.\n \n Os dados: descrição, tipo de agendamento, planta, parceiro e observações serão replicadas para todas as agendas criadas.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoAgrupador – descricao – tipoAgendamento – planta – status – horaOffset – dataHora properties: codigoAgrupador: type: string description: Código agrupador descricao: type: string description: Descrição do agendamento tipoAgendamento: type: string description: Código ou ID do Tipo de Agendamento planta: type: string description: ID ou CNPJ da Planta status: type: string allOf: – #/definitions/statusInicialAgendamento description: Status inicial do agendamento parceiro: type: string description: ID ou CNPJ do Parceiro (Cliente Externo) horaOffset: type: integer format: int64 description: Time zone da hora de agendamento em relação a UTC. Esse valor varia de -12 a 14 minimum: -12 maximum: 14 observacao: type: string description: Observação do agendamento dataHora: type: array items: type: object allOf: – #/definitions/dataHora minimum: 1 description: Lista de datas esperadas para os agendamentos responses: 200: description: Ok schema: type: object required: – agendas properties: agendas: type: array items: type: object allOf: – #/definitions/agenda minimum: 1 description: Lista de agendamentos cadastrados default: description: Error response schema: #/definitions/genericError /agenda/actions/reagendarAgendamento: post: description: Reagenda para uma nova data esperada.\n \n Condições de reagendamento:\n * O Status do agendamento não pode estar CANCELADO, EM EXECUÇÃO ou CONCLUÍDO;\n * A nova data deve ser uma data futura;\n tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – agendaId – dataEsperada – horaEsperada – horaOffset properties: agendaId: type: string description: ID ou código do agendamento dataEsperada: type: string format: date description: Data esperada do agendamento horaEsperada: type: string description: Hora esperada do agendamento horaOffset: type: integer format: int64 description: Time zone da hora de agendamento em relação a UTC. Esse valor varia de -12 a 14 minimum: -12 maximum: 14 responses: 200: description: Ok schema: type: object allOf: – #/definitions/agenda default: description: Error response schema: #/definitions/genericError /agenda/actions/salvarAnexo: post: description: Confirma a gravação do arquivo no serviço de hospedagem na versão em que ocorreu o upload tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo – versao properties: nomeAnexo: type: string description: Nome do anexo versao: type: string description: Versão do anexo (obtida no retorno da primitiva obterUrlUploadAnexo) responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: string description: Resultado da operação default: description: Error response schema: #/definitions/genericError /agenda/actions/excluirAnexo: post: description: Exclui o anexo do repositório tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idAnexo properties: idAnexo: type: string description: ID do anexo a ser excluido responses: 200: description: Ok schema: type: object required: – resultado properties: resultado: type: string description: Resultado da operação default: description: Error response schema: #/definitions/genericError /agenda/actions/cancelarAgendamento: post: description: Ao receber um agendamento com status *Aguardando Confirmação*, *Agendado*, *Rejeitado* e\n *Aguardando Confirmação Solicitante* realizará o cancelamento do agendamento, caso o agendamento possua\n outro status não realiza o cancelamento e gera erro.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agendamento que será cancelado responses: 200: description: Ok schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agenda cancelada default: description: Error response schema: #/definitions/genericError /agenda/actions/rejeitarAgendamento: post: description: Ao receber um agendamento com status *Aguardando Confirmação* e *Aguardando Confirmação Solicitante*\n rejeitará o agendamento, caso o agendamento possua outro status será rejeitado o agendamento e gera erro.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agendamento que será rejeitado responses: 200: description: Ok schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agenda rejeitada default: description: Error response schema: #/definitions/genericError /agenda/actions/aprovarAgendamento: post: description: Ao receber um agendamento com status *Aguardando Confirmação* e *Aguardando Confirmação Solicitante*\n aprovará o agendamento, caso o agendamento possua outro status será rejeitado o agendamento e gera erro.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agendamento que será aprovado responses: 200: description: Ok schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agenda aprovada default: description: Error response schema: #/definitions/genericError /agenda/actions/iniciarAgendamento: post: description: Coloca o agendamento em execução tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agenda properties: agenda: type: string description: UUID da agenda responses: 200: description: Ok schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Retorna a agenda em estado EXECUTANDO default: description: Error response schema: #/definitions/genericError /agenda/actions/finalizarAgendamento: post: description: Finaliza o agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agenda properties: agenda: type: string description: UUID da agenda responses: 200: description: Ok schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Retorna agenda em estado CONCLUIDO default: description: Error response schema: #/definitions/genericError /agenda/actions/aguardarIntegracao: post: description: Aguardar integração antes de iniciar agendamento.\n Quando a **Agenda** está em estado de agendada e precisa aguardar uma integração com sistemas de\n terceiros, a mesma deve entrar no estado de AGUARDANDO_INTEGRACAO e quando obtiver uma reposta\n afirmativa a execução circuito será iniciada.\n Obs.: a agenda precisa está com estado AGENDADO.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agenda – circuito – sequenciaInicial properties: agenda: type: string description: Identificador da agenda circuito: type: string description: Identificador do circuito sequenciaInicial: type: string description: Identificador da sequência inicial do circuito vagaInicial: type: string description: Identificador da vaga que será ocupada responses: 200: description: Ok schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agenda com estado de AGUARDANDO_INTEGRACAO e informações do circuito que será executada após\n a integração ser concluida com sucesso. default: description: Error response schema: #/definitions/genericError /agenda/actions/informarIntegracao: post: description: Informa à agenda sobre o resultado da integração.\n Quando a integração é processada com sucesso e a agenda está com estado de espera pela mesma,\n um sinal para a execução do circuito iniciar é enviado. Em qualquer outro estado, nada se altera.\n Quando um erro é informado e a agenda está com estado de aguardando integração,\n a mesma ficará com estado de erro. Caso a agenda já esteja em execução, o estado não se altera.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agenda – servico – status properties: agenda: type: string description: Identificador da agenda servico: type: string description: Identificador do serviço que está integrando status: type: string allOf: – #/definitions/statusIntegracao description: Status da integração motivoDeFalha: type: string description: Motivo da falha da integração responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /agenda/actions/desativarTipoAgendamento: post: description: Ação para desativar um Tipo de Agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoAgendamento properties: tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento que será desativado responses: 200: description: Ok schema: type: object required: – tipoAgendamento properties: tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento desativado default: description: Error response schema: #/definitions/genericError /agenda/actions/ativarTipoAgendamento: post: description: Ação para ativar um Tipo de Agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoAgendamento properties: tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento que será ativado responses: 200: description: Ok schema: type: object required: – tipoAgendamento properties: tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento ativado default: description: Error response schema: #/definitions/genericError /agenda/actions/bloquearTipoAgendamento: post: description: Ação para bloquear um Tipo de Agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – motivo properties: id: type: string description: Identificação do tipo de Agendamento que será bloqueado motivo: type: string description: Motivo para o bloqueio do tipo de Agendamento responses: 200: description: Ok schema: type: object required: – tipoAgendamento properties: tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento bloqueado default: description: Error response schema: #/definitions/genericError /agenda/actions/desbloquearTipoAgendamento: post: description: Ação para desbloquear um Tipo de Agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificação do tipo de agendamento que será desbloqueado responses: 200: description: Ok schema: type: object required: – tipoAgendamento properties: tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento desbloqueado default: description: Error response schema: #/definitions/genericError /agenda/actions/filtrarAgenda: post: description: Endpoint para filtrar Agendamentos por seus relacionamentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: plantaId: type: string description: Id da planta externalTenantId: type: string description: Id da ExternalTenant tipoAgendamentoId: type: string description: Id do TipoAgendamento motoristaId: type: string description: Id do Motorista veiculoId: type: string description: Id do Veiculo descricao: type: string description: Descrição do Agendamento dataEsperadaAgendamentoInicio: type: string format: date-time description: Data inicial para buscar os agendamentos dataEsperadaAgendamentoFim: type: string format: date-time description: Data Final para buscar os agendamentos status: type: array items: type: string allOf: – #/definitions/statusAgendamento description: Status do Agendamento codigoAgrupador: type: string description: Código agrupador page: type: integer format: int64 description: Offset para paginação size: type: integer format: int64 description: Quantos itens exibir sortField: type: string description: Campo para ordenação sortOrder: type: integer format: int64 description: Se ordenação é ascendente ou descendete responses: 200: description: Ok schema: type: object required: – agendas – totalElements – totalPages properties: agendas: type: array items: type: object allOf: – #/definitions/agenda minimum: 1 description: Lista de execuções filtradas totalElements: type: integer format: int64 description: Total de elementos para paginação totalPages: type: integer format: int64 description: Total de paginas para paginação default: description: Error response schema: #/definitions/genericError /agenda/actions/cancelarAgendamentoPorCancelamentoCircuito: post: description: Ação cancelar um agendamento por cancelamento do circuito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaId properties: agendaId: type: string description: Identificador do agendamento responses: 200: description: Ok schema: type: object required: – agendaCancelada properties: agendaCancelada: type: object allOf: – #/definitions/agenda description: Agendamento cancelado default: description: Error response schema: #/definitions/genericError /agenda/actions/reiniciarAgendamentoPorCancelamentoCircuito: post: description: Ação Reiniciar um agendamento por cancelamento do circuito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaId properties: agendaId: type: string description: Identificador do agendamento responses: 200: description: Ok schema: type: object required: – agendaReiniciada properties: agendaReiniciada: type: object allOf: – #/definitions/agenda description: Agendamento cancelado default: description: Error response schema: #/definitions/genericError /agenda/actions/cadastrarComposicaoVeiculo: post: description: Cadastra uma nova Composição de Veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/composicaoVeiculo responses: 200: description: Ok schema: type: object allOf: – #/definitions/composicaoVeiculo default: description: Error response schema: #/definitions/genericError /agenda/actions/atualizarComposicaoVeiculo: post: description: Atualiza uma nova Composição de Veículo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/composicaoVeiculo responses: 200: description: Ok schema: type: object allOf: – #/definitions/composicaoVeiculo default: description: Error response schema: #/definitions/genericError /agenda/actions/cadastrarUsuarioExterno: post: description: Ação para emitir o usuário para o serviço de usuários externos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nome – sobrenome – email – senha – parceiroId – baseUrl – redirectUrl properties: nome: type: string description: Nome sobrenome: type: string description: Sobrenome do usuario email: type: string description: E-mail do usuário senha: type: string description: Senha do usuário parceiroId: type: string description: Id do parceiro ao qual o usuário será vinculado baseUrl: type: string description: Url de confirmação de e-mail redirectUrl: type: string description: Url que o usário será redirecionado responses: 200: description: Ok schema: type: object allOf: – #/definitions/externalUser default: description: Error response schema: #/definitions/genericError /agenda/actions/ativarUsuarioExterno: post: description: Ativar usuário Externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – usuarioId properties: usuarioId: type: string description: Id do usuário à ser ativado responses: 200: description: Ok schema: type: object allOf: – #/definitions/externalUser default: description: Error response schema: #/definitions/genericError /agenda/actions/desativarUsuarioExterno: post: description: Desativar usuário Externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – usuarioId properties: usuarioId: type: string description: Id do usuário à ser desativado responses: 200: description: Ok schema: type: object allOf: – #/definitions/externalUser default: description: Error response schema: #/definitions/genericError /agenda/actions/confirmarEmailUsuario: post: description: Informar que o usuário confirmou o email tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – email – token properties: email: type: string description: E-mail do usuário à ser confirmado token: type: string description: Token de confirmação do e-mail responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /agenda/actions/adicionarAnexosAoAgendamento: post: description: Adiciona uma lista de anexos ao agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – anexos – agendaId properties: anexos: type: array items: type: object allOf: – #/definitions/anexo minimum: 1 description: Lista de anexos para serem adicionados agendaId: type: string description: ID do agendamento a ser adicionado responses: 200: description: Ok schema: type: object required: – anexos properties: anexos: type: array items: type: object allOf: – #/definitions/anexo minimum: 1 description: Lista de anexos salvos default: description: Error response schema: #/definitions/genericError /agenda/actions/atualizarAgendamento: post: description: Atualiza algumas informações de um agendamento já criado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaId properties: agendaId: type: string description: ID do agendamento composicaoVeiculoId: type: string description: ID da nova composição de veículo motoristaId: type: string description: ID do motorista observacao: type: string description: Nova observação responses: 200: description: Ok schema: type: object required: – agenda properties: agenda: type: object allOf: – #/definitions/agenda description: Agenda atualizada default: description: Error response schema: #/definitions/genericError /agenda/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /agenda/actions/importAgenda: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importTipoAgendamento: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importLimiteOperacao: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importExternalTenant: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importExternalUser: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importComposicaoVeiculo: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importMotorista: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importTipoVeiculo: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importVeiculo: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importPlanta: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importEndereco: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importTurno: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importTurnoData: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importMediaExecucaoCircuito: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importCircuito: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importExecucaoCircuito: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/actions/importHistoricoExecucaoCircuito: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /agenda/entities/agenda: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/agenda responses: 200: description: The created resource schema: #/definitions/agenda default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/agenda responses: 200: description: The created resource schema: #/definitions/agenda default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/agenda default: description: Error response schema: #/definitions/genericError /agenda/entities/agenda/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/agenda responses: 200: description: Ok schema: #/definitions/agenda default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/agenda responses: 200: description: Ok schema: #/definitions/agenda default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/agenda default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/agenda/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/agenda responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/anexo: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/anexo responses: 200: description: The created resource schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/anexo responses: 200: description: The created resource schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/anexo default: description: Error response schema: #/definitions/genericError /agenda/entities/anexo/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/anexo responses: 200: description: Ok schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/anexo responses: 200: description: Ok schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/agenda/{parentId}/anexos: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/anexo responses: 200: description: The created resources schema: type: array items: #/definitions/anexo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/anexo responses: 200: description: The created resources schema: type: array items: #/definitions/anexo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/anexo default: description: Error response schema: #/definitions/genericError /agenda/entities/agenda/{parentId}/anexos/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/anexo responses: 200: description: Ok schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/anexo responses: 200: description: Ok schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/anexo default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/anexo/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/anexo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/tipoAgendamento: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tipoAgendamento responses: 200: description: The created resource schema: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tipoAgendamento responses: 200: description: The created resource schema: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError /agenda/entities/tipoAgendamento/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tipoAgendamento responses: 200: description: Ok schema: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tipoAgendamento responses: 200: description: Ok schema: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/tipoAgendamento/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoAgendamento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/limiteOperacao: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/limiteOperacao responses: 200: description: The created resource schema: #/definitions/limiteOperacao default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/limiteOperacao responses: 200: description: The created resource schema: #/definitions/limiteOperacao default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/limiteOperacao default: description: Error response schema: #/definitions/genericError /agenda/entities/limiteOperacao/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/limiteOperacao responses: 200: description: Ok schema: #/definitions/limiteOperacao default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/limiteOperacao responses: 200: description: Ok schema: #/definitions/limiteOperacao default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/limiteOperacao default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/limiteOperacao/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/limiteOperacao responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/externalTenant: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/externalTenant responses: 200: description: The created resource schema: #/definitions/externalTenant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/externalTenant responses: 200: description: The created resource schema: #/definitions/externalTenant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/externalTenant default: description: Error response schema: #/definitions/genericError /agenda/entities/externalTenant/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/externalTenant responses: 200: description: Ok schema: #/definitions/externalTenant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/externalTenant responses: 200: description: Ok schema: #/definitions/externalTenant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/externalTenant default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/externalTenant/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/externalTenant responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/enderecoExternalTenant: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/enderecoExternalTenant responses: 200: description: The created resource schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/enderecoExternalTenant responses: 200: description: The created resource schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError /agenda/entities/enderecoExternalTenant/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/enderecoExternalTenant responses: 200: description: Ok schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/enderecoExternalTenant responses: 200: description: Ok schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/externalTenant/{parentId}/endereco: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/enderecoExternalTenant responses: 200: description: The created resource schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/enderecoExternalTenant responses: 200: description: The created resource schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError /agenda/entities/externalTenant/{parentId}/endereco/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/enderecoExternalTenant responses: 200: description: Ok schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/enderecoExternalTenant responses: 200: description: Ok schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/enderecoExternalTenant default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/enderecoExternalTenant/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/enderecoExternalTenant responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/externalUser: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/externalUser default: description: Error response schema: #/definitions/genericError /agenda/entities/composicaoVeiculo: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/composicaoVeiculo default: description: Error response schema: #/definitions/genericError /agenda/entities/composicaoVeiculo/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/composicaoVeiculo default: description: Error response schema: #/definitions/genericError /agenda/entities/motorista: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/motorista default: description: Error response schema: #/definitions/genericError /agenda/entities/motorista/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/motorista default: description: Error response schema: #/definitions/genericError /agenda/entities/tipoVeiculo: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tipoVeiculo default: description: Error response schema: #/definitions/genericError /agenda/entities/tipoVeiculo/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tipoVeiculo default: description: Error response schema: #/definitions/genericError /agenda/entities/veiculo: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/veiculo default: description: Error response schema: #/definitions/genericError /agenda/entities/veiculo/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/veiculo default: description: Error response schema: #/definitions/genericError /agenda/entities/planta: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/planta responses: 200: description: The created resource schema: #/definitions/planta default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/planta responses: 200: description: The created resource schema: #/definitions/planta default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/planta default: description: Error response schema: #/definitions/genericError /agenda/entities/planta/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/planta responses: 200: description: Ok schema: #/definitions/planta default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/planta responses: 200: description: Ok schema: #/definitions/planta default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/planta default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/planta/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/planta responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/endereco: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/endereco responses: 200: description: The created resource schema: #/definitions/endereco default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/endereco responses: 200: description: The created resource schema: #/definitions/endereco default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/endereco default: description: Error response schema: #/definitions/genericError /agenda/entities/endereco/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/endereco responses: 200: description: Ok schema: #/definitions/endereco default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/endereco responses: 200: description: Ok schema: #/definitions/endereco default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/endereco default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /agenda/entities/endereco/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/endereco responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /agenda/entities/turno: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/turno default: description: Error response schema: #/definitions/genericError /agenda/entities/turno/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/turno default: description: Error response schema: #/definitions/genericError /agenda/entities/turnoData: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/turnoData default: description: Error response schema: #/definitions/genericError /agenda/entities/turnoData/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/turnoData default: description: Error response schema: #/definitions/genericError /agenda/entities/mediaExecucaoCircuito: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/mediaExecucaoCircuito default: description: Error response schema: #/definitions/genericError /agenda/entities/circuito: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/circuito default: description: Error response schema: #/definitions/genericError /agenda/entities/execucaoCircuito: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/execucaoCircuito default: description: Error response schema: #/definitions/genericError /agenda/entities/execucaoCircuito/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/execucaoCircuito default: description: Error response schema: #/definitions/genericError /agenda/entities/historicoExecucaoCircuito: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/historicoExecucaoCircuito default: description: Error response schema: #/definitions/genericError /agenda/entities/historicoExecucaoCircuito/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/historicoExecucaoCircuito default: description: Error response schema: #/definitions/genericError definitions: statusAgendamento: description: Status da Agenda type: string enum: – AGUARDANDO_CONFIRMACAO – AGUARDANDO_CONFIRMACAO_SOLICITANTE – AGENDADO – REJEITADO – CANCELADO – EM_EXECUCAO – CONCLUIDO – AGUARDANDO_INTEGRACAO – REJEITADO_POR_INTEGRACAO statusInicialAgendamento: description: Status ao criar um agendamento type: string enum: – AGUARDANDO_CONFIRMACAO – AGUARDANDO_CONFIRMACAO_SOLICITANTE – AGENDADO tipoAtividadeTipoAgedamento: description: Informa que a Agenda Reservada é uma Descarregamento(Recebimento) ou um Carregamento(Expedição) type: string enum: – CARREGAMENTO – DESCARREGAMENTO statusIntegracao: description: Status para uma determinada integração type: string enum: – PROCESSADA – REJEITADA tipoMotorista: description: Tipo de Motorista type: string enum: – PROPRIO – AGREGADO – TERCEIRO unidadeFederativa: description: Unidades Federativas do Brasil type: string enum: – ACRE – ALAGOAS – AMAPA – AMAZONAS – BAHIA – CEARA – DISTRITO_FEDERAL – ESPIRITO_SANTO – GOIAS – MARANHAO – MATO_GROSSO – MATO_GROSSO_DO_SUL – MINAS_GERAIS – PARA – PARAIBA – PARANA – PERNAMBUCO – PIAUI – RIO_DE_JANEIRO – RIO_GRANDE_DO_NORTE – RIO_GRANDE_DO_SUL – RONDONIA – RORAIMA – SANTA_CATARINA – SAO_PAULO – SERGIPE – TOCANTINS serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN 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 – 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 horarioDisponivel: description: Contém um horário com a quantidade de agendamentos disponíveis type: object required: – horario – disponivel properties: horario: type: string description: Representa a hora disponivel: type: integer format: int64 description: Representa a quantidade de agendamentos disponíveis de acordo com o limite de operação mediaPorCircuito: description: Contém a média de execução do circuito medida pelo circuito type: object required: – descricao – media properties: descricao: type: string description: Descrição do circuito media: type: object allOf: – #/definitions/mediaExecucaoCircuito description: Média da execução do circuito mediaPorComposicaoVeiculo: description: Contém a média de execução do circuito medida pelo tipo de veículo type: object required: – descricao – composicaoVeiculo – media properties: descricao: type: string description: Descrição do circuito composicaoVeiculo: type: object allOf: – #/definitions/composicaoVeiculo description: Tipo do veículo utilizado na média media: type: object allOf: – #/definitions/mediaExecucaoCircuito description: Média da execução do circuito tenant: description: Os dados de um tenant type: object required: – nome – dominio – ativo – master – local properties: nome: type: string description: Nome do tenant dominio: type: string description: O domínio do tenant ativo: type: boolean description: Indica se o tenant está ativo master: type: boolean description: Indica se o tenant é master local: type: string description: O local do tenant checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck dataHora: description: Representa a data e a hora type: object required: – data – hora properties: data: type: string format: date description: Data hora: type: string description: Hora agenda: description: Agenda type: object required: – tipoAgendamento – descricao – dataEsperadaAgendamento – status properties: id: type: string format: uuid description: Id da Agenda codigo: type: integer format: int64 description: Código identificador da agenda tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo do Agendamento descricao: type: string description: Descrição do Agendamento dataEsperadaAgendamento: type: string format: date-time description: Data Esperada de Inicio do Agendamento dataInicioExecucao: type: string format: date-time description: Data de inicio da execucao da Agenda dataFimExecucao: type: string format: date-time description: Data de fim da execucao da Agenda motorista: type: object allOf: – #/definitions/motorista description: Dados do Motorista veiculo: type: object allOf: – #/definitions/composicaoVeiculo description: dados do Veículo status: type: string allOf: – #/definitions/statusAgendamento description: Status Agendamento planta: type: object allOf: – #/definitions/planta description: Planta de Operação do Agendamento externalTenant: type: object allOf: – #/definitions/externalTenant description: Indica o tenant de terceiros da agenda observacao: type: string description: Observações para informar situações do agendamento anexos: type: array items: type: object allOf: – #/definitions/anexo description: Lista de anexos do agendamento codigoAgrupador: type: string description: Código agrupador circuito: type: string description: Identificador do circuito para este agendamento sequenciaInicial: type: string description: Sequência inicial do circuito para este agendamento vagaInicial: type: string description: Vaga inicial do circuito para este agendamento createdByPatio: type: boolean description: Indica se a agenda foi criada pelo serviço patio default: false createdByErp: type: boolean description: Indica se a agenda foi criada pelo serviço ERP default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: anexo: description: Anexos do agendamento type: object required: – descricao – nome – url properties: id: type: string format: uuid description: Id do agendamento descricao: type: string description: Descrição do agendamento nome: type: string description: Nome do anexo a ser usado no repositório remoto (Não pode ser repetido, senão o arquivo será sobreescrito) url: type: string description: Url do anexo no repositório de arquivos agenda: type: object allOf: – #/definitions/agenda description: Agenda que o anexo pertence createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoAgendamento: description: Tipo de Agendamento type: object required: – codigo – descricao – tipoAtividade properties: id: type: string format: uuid description: uuid codigo: type: string description: Código Identificador do Tipo de Agendamento descricao: type: string description: Descrição do Tipo Agendamento ativo: type: boolean description: Indica se o Tipo de Agendamento está ativo tipoAtividade: type: string allOf: – #/definitions/tipoAtividadeTipoAgedamento description: Define se o Tipo de Agendamento é de Carregamento ou Descarregamento bloqueio: type: boolean description: Indica o bloqueio do Tipo de Agendamento motivo: type: string description: Motivo do bloqueio createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: limiteOperacao: description: Limite de Operação – define os intervalos de tempo em que as agendas podem ser cadastradas e limite de agendamentos nesse mesmo intervalo type: object required: – descricao – tempoDeExecucao – limitePorIntervalo – planta – tipoAgendamentos properties: id: type: string format: uuid description: ID descricao: type: string description: Descrição do limite tempoDeExecucao: type: integer format: int64 description: Informa o tempo de execução estimado (em segundos) minimum: 1 limitePorIntervalo: type: integer format: int64 description: Informa o limite de agendamentos em um intervalo de tempo definido pelo tempo de execução minimum: 1 planta: type: object allOf: – #/definitions/planta description: Planta ao qual o limite está vinculado turnos: type: array items: type: object allOf: – #/definitions/turno description: Turnos vinculados ao limite de operação tipoAgendamentos: type: array items: type: object allOf: – #/definitions/tipoAgendamento minimum: 1 description: Lista de Tipos de Agendamentos ligados ao limite de operação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: externalTenant: description: Representa um *Parceiro* type: object required: – descricao – cnpj – ativo properties: id: type: string format: uuid description: ID do parceiro descricao: type: string description: Descrição do parceiro cnpj: type: string maxLength: 18 description: CNPJ do parceiro tenantDomain: type: string description: Domínio do parceiro, ex: senior.com.br ativo: type: boolean description: Indica se o parceiro está ativo veiculos: type: array items: type: object allOf: – #/definitions/veiculo description: Veículos vinculados ao parceiro motoristas: type: array items: type: object allOf: – #/definitions/motorista description: Motoristas vinculados ao parceiro endereco: type: object allOf: – #/definitions/enderecoExternalTenant description: Endereço do parceiro externo criarAgendaStatusAgendado: type: boolean description: Criar agenda com status Agendado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: enderecoExternalTenant: description: Endereço do parceiro externo type: object required: – logradouro – bairro – cidade – estado – pais – cep properties: id: type: string format: uuid description: ID do endereço do parceiro externo logradouro: type: string description: Logradouro numero: type: string description: Número complemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: string description: Cidade estado: type: string description: Estado pais: type: string description: País cep: type: string description: Código postal externalTenant: type: object allOf: – #/definitions/externalTenant description: Parceiro externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: externalUser: description: Representa um usuário externo type: object required: – nome – sobrenome – email – ativo – confirmouEmail – externalTenant properties: id: type: string format: uuid description: Id do usuário nome: type: string description: Nome sobrenome: type: string description: Sobrenome do usuario email: type: string description: E-mail do usuário ativo: type: boolean description: Indica se o usuario está Ativo confirmouEmail: type: boolean description: Indica se o usuário confirmou o email externalTenant: type: object allOf: – #/definitions/externalTenant description: Parceiro ao qual o usuario externo está vinculado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: composicaoVeiculo: description: Composição de veículos type: object required: – primario properties: id: type: string maxLength: 36 description: ID da composição descricao: type: string description: Descrição da composição primario: type: object allOf: – #/definitions/veiculo description: Veículo primário secundarios: type: array items: type: object allOf: – #/definitions/veiculo description: Veículos secundários createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: motorista: description: Dados do motorista type: object required: – nome – tipoMotorista properties: id: type: string description: uuid nome: type: string description: Nome do motorista cpf: type: string description: CPF do motorista telefone: type: string description: Telefone do motorista contato: type: string description: Contato do motorista bloqueio: type: boolean description: Indica o bloqueio do motorista default: false motivo: type: string description: Motivo do bloqueio categoriaCNH: type: string description: Categoria da CNH validadeCNH: type: string format: date description: Validade da CNH tipoMotorista: type: string allOf: – #/definitions/tipoMotorista description: Tipo de Motorista parceiros: type: array items: type: object allOf: – #/definitions/externalTenant description: Indica os parceiros que estão vinculados ao motorista. Caso vazio, o motorista é identificado como colaborador da empresa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoVeiculo: description: Tipo de veículo type: object required: – id – descricao properties: id: type: string format: uuid description: ID descricao: type: string description: Descrição do tipo de veículo semirreboque: type: string description: Tipo do semirreboque caso o Tipo de Veículo seja um semirreboque createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: veiculo: description: Dados do Veiculo type: object required: – descricao – placa – tipoVeiculo properties: id: type: string description: uuid descricao: type: string description: Descrição do veiculo placa: type: string description: Placa do veiculo bloqueado: type: boolean description: Indica se o veículo está bloqueado default: false motivoDoBloqueio: type: string description: Motivo do bloqueio do veículo tipoVeiculo: type: object allOf: – #/definitions/tipoVeiculo description: Tipo do veiculo parceiros: type: array items: type: object allOf: – #/definitions/externalTenant description: Indica os parceiros que são donos do veículo. Caso vazio, o veículo é identificado como frota própria createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: planta: description: Planta de operação type: object required: – nome properties: id: type: string description: uuid nome: type: string description: Nome da planta cnpj: type: array items: type: string description: Lista de CNPJs vinculados a planta endereco: type: object allOf: – #/definitions/endereco description: Endereço da planta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: endereco: description: Endereço da planta type: object required: – id – logradouro – bairro – cidade – estado – pais – cep properties: id: type: string description: ID do endereço logradouro: type: string description: Logradouro numero: type: string description: Número complemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: string description: Cidade estado: type: string description: Estado pais: type: string description: País cep: type: string description: Código postal createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: turno: description: Representa um Turno. Um Turno é uma faixa de tempo em que a Planta estará disponível para execução de tarefas type: object required: – id – horaInicio – horaFim – ativo – bloqueado – planta properties: id: type: string description: ID que identifica o turno descricao: type: string description: Descrição do turno horaInicio: type: string description: Horário de início do turno horaFim: type: string description: Horário de fim do turno ativo: type: boolean description: Indica se o turno está ativo ou não bloqueado: type: boolean description: Indica se o turno encontra-se bloqueado motivoBloqueio: type: string description: Mensagem informativa para o motivo do turno estar bloqueado planta: type: object allOf: – #/definitions/planta description: Planta ao qual o turno está vinculado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: turnoData: description: Representa um turno vinculado a uma determinada data do ano type: object required: – id – data – turno – ativo – bloqueado properties: id: type: string description: ID que identifica o turno vinculado a data data: type: string format: date description: Data ao qual se deseja vincular um turno turno: type: object allOf: – #/definitions/turno description: Turno vinculado a data determinada ativo: type: boolean description: Indica se o turno está ativo para a data determinada bloqueado: type: boolean description: Indica se o turno encontra-se bloqueado para a data determinada motivoBloqueio: type: string description: Mensagem informativa para o motivo do turno estar bloqueado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: mediaExecucaoCircuito: description: Representa o tempo das execuções dos circuitos type: object required: – id – media – percentil90 – percentil80 – percentil70 properties: id: type: string format: uuid description: Identificador da média tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de agendamento da execução circuito: type: object allOf: – #/definitions/circuito description: Circuito da execução composicaoVeiculo: type: object allOf: – #/definitions/composicaoVeiculo description: Composição de veículos media: type: integer format: int64 description: Média em segundos da execucao do circuito percentil90: type: integer format: int64 description: Tempo máximo em que 90% das execuções de circuitos levaram para concluir percentil80: type: integer format: int64 description: Tempo máximo em que 80% das execuções de circuitos levaram para concluir percentil70: type: integer format: int64 description: Tempo máximo em que 70% das execuções de circuitos levaram para concluir createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: circuito: description: Circuito type: object required: – id – descricao – tipoAgendamento – planta properties: id: type: string description: ID descricao: type: string description: Descrição do circuito tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo do agendamento do circuito planta: type: object allOf: – #/definitions/planta description: Planta em que o circuito deve ser executado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: execucaoCircuito: description: Execucao do Circuito type: object required: – id – agenda – circuito – status properties: id: type: string format: uuid description: ID agenda: type: object allOf: – #/definitions/agenda description: Agendamento circuito: type: object allOf: – #/definitions/circuito description: Circuito da execução status: type: string description: Status da execução dataInicio: type: string format: date-time description: Data inicio da execução dataFim: type: string format: date-time description: Data fim da execução createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: historicoExecucaoCircuito: description: Armazena o histórico de execuções dos circuitos type: object required: – id – execucaoCircuito – sequenciaCircuito – vaga – dataInicio – status properties: id: type: string format: uuid description: ID execucaoCircuito: type: object allOf: – #/definitions/execucaoCircuito description: Execução do circuito sequenciaCircuito: type: string description: Sequencia do Circuito vaga: type: string description: Vaga alocada pelo veiculo dataInicio: type: string format: date-time description: Data inicio da execução dataFim: type: string format: date-time description: Data fim da execução status: type: string description: Status da execução da sequência do circuito statusFinal: type: string description: Statis Final da execução da sequência do circuito 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