analytics

2.0info: 4.4.0 analytics description: Servico de analise de operacao do portal agendamento x-senior-domain: Controle de Pátio x-senior-domain-path: yms x-senior-service-path: analytics contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/ymssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /analytics/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/healthcheck: post: description: Verificação 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificação 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportVeiculoNaPlanta: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportVeiculoNaArea: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportAgendamentoNoDia: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportTempoExecucaoAgenda: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportTempoExecucaoArea: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportTempoExecucaoCircuito: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportArea: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/queries/exportSequenciaCircuito: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/recalcularAgendamentoNoDia: post: description: Recalcula a quantidade de agendamentos por dia em uma determinada planta tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importVeiculoNaPlanta: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importVeiculoNaArea: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importAgendamentoNoDia: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importTempoExecucaoAgenda: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importTempoExecucaoArea: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importTempoExecucaoCircuito: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importArea: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/actions/importSequenciaCircuito: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/signals/contaTempoExecucaoAgenda: post: description: Faz a contagem do tempo de execucao do agendamento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /analytics/signals/contaTempoExecucaoArea: post: description: Faz a contagem do tempo de execucao em uma determinada área tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /analytics/entities/veiculoNaPlanta: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/veiculoNaPlanta responses: 200: description: The created resource schema: #/definitions/veiculoNaPlanta 401: description: Invalid Credentials 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/veiculoNaPlanta responses: 200: description: The created resource schema: #/definitions/veiculoNaPlanta 401: description: Invalid Credentials 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/veiculoNaPlanta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/veiculoNaPlanta/{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/veiculoNaPlanta responses: 200: description: Ok schema: #/definitions/veiculoNaPlanta 401: description: Invalid Credentials 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/veiculoNaPlanta responses: 200: description: Ok schema: #/definitions/veiculoNaPlanta 401: description: Invalid Credentials 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/veiculoNaPlanta 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/veiculoNaPlanta/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/veiculoNaPlanta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/veiculoNaArea: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/veiculoNaArea responses: 200: description: The created resource schema: #/definitions/veiculoNaArea 401: description: Invalid Credentials 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/veiculoNaArea responses: 200: description: The created resource schema: #/definitions/veiculoNaArea 401: description: Invalid Credentials 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/veiculoNaArea 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/veiculoNaArea/{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/veiculoNaArea responses: 200: description: Ok schema: #/definitions/veiculoNaArea 401: description: Invalid Credentials 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/veiculoNaArea responses: 200: description: Ok schema: #/definitions/veiculoNaArea 401: description: Invalid Credentials 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/veiculoNaArea 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/veiculoNaArea/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/veiculoNaArea responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/agendamentoNoDia: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/agendamentoNoDia responses: 200: description: The created resource schema: #/definitions/agendamentoNoDia 401: description: Invalid Credentials 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/agendamentoNoDia responses: 200: description: The created resource schema: #/definitions/agendamentoNoDia 401: description: Invalid Credentials 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/agendamentoNoDia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/agendamentoNoDia/{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/agendamentoNoDia responses: 200: description: Ok schema: #/definitions/agendamentoNoDia 401: description: Invalid Credentials 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/agendamentoNoDia responses: 200: description: Ok schema: #/definitions/agendamentoNoDia 401: description: Invalid Credentials 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/agendamentoNoDia 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/agendamentoNoDia/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/agendamentoNoDia responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tempoExecucaoAgenda: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tempoExecucaoAgenda responses: 200: description: The created resource schema: #/definitions/tempoExecucaoAgenda 401: description: Invalid Credentials 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/tempoExecucaoAgenda responses: 200: description: The created resource schema: #/definitions/tempoExecucaoAgenda 401: description: Invalid Credentials 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/tempoExecucaoAgenda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tempoExecucaoAgenda/{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/tempoExecucaoAgenda responses: 200: description: Ok schema: #/definitions/tempoExecucaoAgenda 401: description: Invalid Credentials 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/tempoExecucaoAgenda responses: 200: description: Ok schema: #/definitions/tempoExecucaoAgenda 401: description: Invalid Credentials 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/tempoExecucaoAgenda 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tempoExecucaoAgenda/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tempoExecucaoAgenda responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tempoExecucaoArea: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tempoExecucaoArea responses: 200: description: The created resource schema: #/definitions/tempoExecucaoArea 401: description: Invalid Credentials 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/tempoExecucaoArea responses: 200: description: The created resource schema: #/definitions/tempoExecucaoArea 401: description: Invalid Credentials 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/tempoExecucaoArea 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tempoExecucaoArea/{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/tempoExecucaoArea responses: 200: description: Ok schema: #/definitions/tempoExecucaoArea 401: description: Invalid Credentials 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/tempoExecucaoArea responses: 200: description: Ok schema: #/definitions/tempoExecucaoArea 401: description: Invalid Credentials 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/tempoExecucaoArea 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tempoExecucaoArea/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tempoExecucaoArea responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tempoExecucaoCircuito: 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/tempoExecucaoCircuito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/agenda: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/agenda/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/agenda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tipoAgendamento: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/tipoAgendamento/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tipoAgendamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/area: 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/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/area/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/area 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/sequenciaCircuito: 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/sequenciaCircuito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/sequenciaCircuito/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/sequenciaCircuito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/circuito/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/circuito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/composicaoVeiculo: 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/composicaoVeiculo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /analytics/entities/composicaoVeiculo/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/composicaoVeiculo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN statusAgendamento: description: Status da Agenda type: string enum: – AGUARDANDO_CONFIRMACAO – AGUARDANDO_CONFIRMACAO_SOLICITANTE – AGENDADO – REJEITADO – CANCELADO – EM_EXECUCAO – CONCLUIDO statusCircuito: description: Controle de execução de Circuito type: string enum: – AGUARDANDO – EXECUTANTO – CONCLUIDO – REVERTIDO – CANCELADO statusExecucaoSequencia: description: Status de execução da sequência do circuito type: string enum: – EXECUTANDO – CONCLUIDO – REVERTIDO – AGUARDANDO 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 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 veiculoNaPlanta: description: Armazena a quantidade de veículos em execução na planta type: object required: – id – quantidade – planta properties: id: type: string format: uuid description: ID veículo na planta quantidade: type: integer format: int64 description: Quantidade de veículo na planta planta: type: string description: ID da planta veiculoNaArea: description: Armazena a quantidade de veículos em execução na área type: object required: – id – quantidade – area properties: id: type: string format: uuid description: ID veículo na área quantidade: type: integer format: int64 description: Quantidade de veículo na área area: type: object allOf: – #/definitions/area description: ID da área agendamentoNoDia: description: Armazena a quantidade de agendamentos na planta por dia type: object required: – id – quantidade – data – planta properties: id: type: string format: uuid description: ID agendamento no dia quantidade: type: integer format: int64 description: Quantidade de agendamentos por dia data: type: string format: date description: Data da contagem planta: type: string description: ID da planta tempoExecucaoAgenda: description: Tempo de execução de um agendamento type: object required: – id – agenda – tempo properties: id: type: string format: uuid description: ID do tempo de execução do agendamento agenda: type: object allOf: – #/definitions/agenda description: Agenda tempo: type: integer format: int64 description: Tempo em segundos da execução do agendamento tempoExecucaoArea: description: Tempo de execução em uma determinada área type: object required: – id – area – veiculo – tempo properties: id: type: string format: uuid description: ID do tempo de execução na área area: type: object allOf: – #/definitions/area description: Área veiculo: type: object allOf: – #/definitions/composicaoVeiculo description: Veiculo do circuito tempo: type: integer format: int64 description: Tempo em segundos da execução na área tempoExecucaoCircuito: description: Representa o tempo das execuções dos circuitos type: object required: – id – tempo – circuito – composicaoVeiculo properties: id: type: string description: Id tempo: type: integer format: int64 description: Tempo em segundos da execucao do circuito circuito: type: object allOf: – #/definitions/circuito description: Circuito em que o tempo se refere composicaoVeiculo: type: object allOf: – #/definitions/composicaoVeiculo description: Composição de veículos utilizada na execução do circuito mediaExecucaoCircuito: description: Representa o tempo das execuções dos circuitos type: object required: – 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 utilizada na execução do circuito 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 agenda: description: Agenda type: object required: – id – status – dataEsperadaAgendamento – planta properties: id: type: string description: uuid status: type: string allOf: – #/definitions/statusAgendamento description: Status 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 tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo do agendamento planta: type: string description: Id da Planta de Operação do Agendamento motorista: type: object allOf: – #/definitions/motorista description: Motorista do agendamento veiculo: type: object allOf: – #/definitions/composicaoVeiculo description: Dados do Veículo tipoAgendamento: description: Tipo de Agendamento type: object required: – id – codigo – descricao properties: id: type: string description: ID tipo agendamento codigo: type: string description: Código Identificador do Tipo de Agendamento descricao: type: string description: Descrição do Tipo Agendamento area: description: Subdivisões da Planta que possuem um objetivo específico. type: object required: – id – planta properties: id: type: string description: uuid planta: type: string description: Planta em que a area está localizada descricao: type: string description: Descrição da área sequenciaCircuito: description: Sequencia de execução do circuito type: object required: – id – area properties: id: type: string description: ID da sequencia de circuito area: type: object allOf: – #/definitions/area description: Area do circuito execucaoCircuito: description: Execucao do Circuito type: object required: – id – sequenciaCircuito – status – circuito properties: id: type: string description: ID da execução de circuito sequenciaCircuito: type: object allOf: – #/definitions/sequenciaCircuito description: Sequencia do Circuito status: type: string allOf: – #/definitions/statusCircuito description: Status do circuito dataInicio: type: string format: date-time description: Data inicio da execução dataFim: type: string format: date-time description: Data fim da execução circuito: type: object allOf: – #/definitions/circuito description: Circuito da execucao veiculo: type: object allOf: – #/definitions/composicaoVeiculo description: Veiculo do circuito historico: type: array items: type: object allOf: – #/definitions/historicoExecucaoCircuito description: Histórico das execuções nas sequências historicoExecucaoCircuito: description: Armazena o histórico de execuções dos circuitos type: object required: – id – sequenciaCircuito – dataInicio – status properties: id: type: string description: ID execucaoCircuito: type: object allOf: – #/definitions/execucaoCircuito description: Execução do circuito sequenciaCircuito: type: object allOf: – #/definitions/sequenciaCircuito description: Sequencia do Circuito 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 allOf: – #/definitions/statusExecucaoSequencia description: Status da execução da sequência do circuito 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 veiculo: description: Veiculo type: object required: – id – descricao – placa – tipoVeiculo properties: id: type: string description: uuid descricao: type: string description: Descrição do veiculo placa: type: string description: Placa do veiculo rntrc: type: string description: Registro do veiculo tipoVeiculo: type: object allOf: – #/definitions/tipoVeiculo description: Tipo do veiculo motorista: description: Motorista type: object required: – id – nome properties: id: type: string description: uuid nome: type: string description: Nome do motorista 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: string description: Planta em que o circuito deve ser executado composicaoVeiculo: description: Composição de veículos type: object required: – id – descricao properties: id: type: string format: uuid description: ID descricao: type: string description: Descrição da composição 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