Portal de Agendamento (portalagendamento)

patio (Controle de Patio)

7 views 04/08/2020 integrador 0

2.0info: 1.4.0 Controle de Patio description: Serviço controle de Patio do Portal Agendamento x-senior-domain: Portal de Agendamento x-senior-domain-path: portalagendamento x-senior-service-path: patio 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/portalagendamentosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /patio/queries/buscarHistoricoControleChegada: post: description: Query para buscar histórico de controle de chegadas relacionado a determinada área tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – areaId properties: areaId: type: string description: ID da área para buscar o histórico responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/controleArea minimum: 1 description: Ultimos dados de controle default: description: Error response schema: #/definitions/genericError get: description: Query para buscar histórico de controle de chegadas relacionado a determinada área tags: – Queries x-senior-visibility: PRIVATE parameters: – name: areaId in: query required: true type: string responses: 200: description: Ok schema: type: object required: – content properties: content: type: array items: type: object allOf: – #/definitions/controleArea minimum: 1 description: Ultimos dados de controle default: description: Error response schema: #/definitions/genericError /patio/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 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 /patio/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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/queries/exportVaga: 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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/queries/exportControleArea: 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 get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /patio/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 /patio/actions/ativarArea: post: description: Ação para ativar uma area tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idArea properties: idArea: type: string description: Area que será ativada responses: 200: description: Ok schema: type: object required: – area properties: area: type: object allOf: – #/definitions/area description: Area ativa default: description: Error response schema: #/definitions/genericError /patio/actions/desativarArea: post: description: Ação para desativar area tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idArea properties: idArea: type: string description: Area que sera desativada responses: 200: description: Ok schema: type: object required: – area properties: area: type: object allOf: – #/definitions/area description: Area desativada default: description: Error response schema: #/definitions/genericError /patio/actions/executarCircuito: post: description: Ação para executar circuito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – execucaoCircuitoId properties: execucaoCircuitoId: type: string description: Execucao a ser concluida vagaId: type: string description: Vaga a ser ocupada sequenciaCircuitoId: type: string description: Proxima sequencia da execucao responses: 200: description: Ok schema: type: object required: – execucaoCircuito properties: execucaoCircuito: type: object allOf: – #/definitions/execucaoCircuito description: Proxima execucao circuito default: description: Error response schema: #/definitions/genericError /patio/actions/reverterCircuito: post: description: Ação para reverter a execução do circuito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – execucaoCircuitoId – vagaId – sequenciaCircuitoId properties: execucaoCircuitoId: type: string description: Execucao a ser concluida vagaId: type: string description: Vaga a ser ocupada sequenciaCircuitoId: type: string description: Proxima sequencia da execucao responses: 200: description: Ok schema: type: object required: – execucaoCircuito properties: execucaoCircuito: type: object allOf: – #/definitions/execucaoCircuito description: Proxima execucao circuito default: description: Error response schema: #/definitions/genericError /patio/actions/criarExecucaoCircuito: post: description: Ação para criar a execução do circuito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – circuito – agenda – veiculo – motorista – sequenciaCircuito – vaga properties: circuito: type: object allOf: – #/definitions/circuito description: Circuito que sera executado agenda: type: object allOf: – #/definitions/agenda description: Agenda da execucao veiculo: type: object allOf: – #/definitions/veiculo description: Veiculo agendado motorista: type: object allOf: – #/definitions/motorista description: Motorista agendado sequenciaCircuito: type: object allOf: – #/definitions/sequenciaCircuito description: A primeira sequencia selecionada pelo usuário vaga: type: object allOf: – #/definitions/vaga description: A vaga a ser ocupada pelo veiculo responses: 200: description: Ok schema: type: object required: – execucaoCircuito properties: execucaoCircuito: type: object allOf: – #/definitions/execucaoCircuito description: A execucao do circuito pronta para ser executada default: description: Error response schema: #/definitions/genericError /patio/actions/filtrarExecucaoCircuito: post: description: Endpoint para filtrar circuito 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 areaId: type: string description: Id da área circuitoId: type: string description: Id do circuito veiculoId: type: string description: Id do veículo 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: – execucoes – totalElements – totalPages properties: execucoes: type: array items: type: object allOf: – #/definitions/execucaoCircuito 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 /patio/actions/cancelarExecucaoCircuitoReiniciarAgendamento: post: description: Cancelar a Execução do Circuito sem cancelar o agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – execucaoCircuitoId properties: execucaoCircuitoId: type: string description: Execucao a ser Cancelado responses: 200: description: Ok schema: type: object required: – circuitoCancelado properties: circuitoCancelado: type: object allOf: – #/definitions/execucaoCircuito description: Circuito Cancelado default: description: Error response schema: #/definitions/genericError /patio/actions/cancelarExecucaoCircuitoCancelarAgendamento: post: description: Cancelar a Execução do Circuito e Cancelar o agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – execucaoCircuitoId properties: execucaoCircuitoId: type: string description: Execucao a ser Cancelado responses: 200: description: Ok schema: type: object required: – circuitoCancelado properties: circuitoCancelado: type: object allOf: – #/definitions/execucaoCircuito description: Circuito Cancelado default: description: Error response schema: #/definitions/genericError /patio/actions/vagaChangeAll: post: description: Retorna todas as vagas cadastradas tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – vaga properties: vaga: type: array items: type: object allOf: – #/definitions/vaga minimum: 1 description: Lista de vagas default: description: Error response schema: #/definitions/genericError /patio/actions/filtrarVaga: post: description: Endpoint para filtrar Vaga por seus relacionamentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: descricao: type: string description: Descricao da Vaga rua: type: integer format: int64 description: Rua da Vaga numero: type: integer format: int64 description: Numero da Vaga areaId: type: string description: Id da area ocupada: type: boolean description: Vaga ocupada ativo: type: boolean description: Vaga ativa 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: – vagas – totalElements – totalPages properties: vagas: type: array items: type: object allOf: – #/definitions/vaga 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 /patio/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 descricao: type: string description: Id da ExternalTenant dataEsperada: type: string format: date description: Data esperada do Agendamento status: type: string allOf: – #/definitions/statusAgendamento description: Status do Agendamento motoristaId: type: string description: Id do Motorista veiculoId: type: string description: Id do Veículo 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 /patio/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /patio/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: default: description: Error response schema: #/definitions/genericError /patio/actions/importVaga: 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 /patio/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 /patio/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 /patio/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 /patio/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 /patio/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 /patio/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 /patio/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 /patio/actions/importControleArea: 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 /patio/entities/area: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/area responses: 200: description: The created resource schema: #/definitions/area 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/area responses: 200: description: The created resource schema: #/definitions/area 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/area default: description: Error response schema: #/definitions/genericError /patio/entities/area/{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/area responses: 200: description: Ok schema: #/definitions/area 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/area responses: 200: description: Ok schema: #/definitions/area 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/area 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 /patio/entities/area/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/area responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /patio/entities/vaga: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vaga responses: 200: description: The created resource schema: #/definitions/vaga 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/vaga responses: 200: description: The created resource schema: #/definitions/vaga 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/vaga default: description: Error response schema: #/definitions/genericError /patio/entities/vaga/{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/vaga responses: 200: description: Ok schema: #/definitions/vaga 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/vaga responses: 200: description: Ok schema: #/definitions/vaga 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/vaga 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 /patio/entities/vaga/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/vaga responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /patio/entities/circuito: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/circuito responses: 200: description: The created resource schema: #/definitions/circuito 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/circuito responses: 200: description: The created resource schema: #/definitions/circuito 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/circuito default: description: Error response schema: #/definitions/genericError /patio/entities/circuito/{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/circuito responses: 200: description: Ok schema: #/definitions/circuito 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/circuito responses: 200: description: Ok schema: #/definitions/circuito 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/circuito 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 /patio/entities/circuito/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/circuito responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /patio/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 default: description: Error response schema: #/definitions/genericError /patio/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 default: description: Error response schema: #/definitions/genericError /patio/entities/circuito/{parentId}/sequencias: post: 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/sequenciaCircuito responses: 200: description: The created resources schema: type: array items: #/definitions/sequenciaCircuito 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: array items: – #/definitions/sequenciaCircuito responses: 200: description: The created resources schema: type: array items: #/definitions/sequenciaCircuito 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/sequenciaCircuito default: description: Error response schema: #/definitions/genericError /patio/entities/circuito/{parentId}/sequencias/{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/sequenciaCircuito responses: 200: description: Ok schema: #/definitions/sequenciaCircuito 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/sequenciaCircuito responses: 200: description: Ok schema: #/definitions/sequenciaCircuito 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/sequenciaCircuito 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 /patio/entities/execucaoCircuito: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/execucaoCircuito responses: 200: description: The created resource schema: #/definitions/execucaoCircuito 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/execucaoCircuito responses: 200: description: The created resource schema: #/definitions/execucaoCircuito 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/execucaoCircuito default: description: Error response schema: #/definitions/genericError /patio/entities/execucaoCircuito/{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/execucaoCircuito responses: 200: description: Ok schema: #/definitions/execucaoCircuito 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/execucaoCircuito responses: 200: description: Ok schema: #/definitions/execucaoCircuito 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/execucaoCircuito 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 /patio/entities/execucaoCircuito/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/execucaoCircuito responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /patio/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 /patio/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 /patio/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 /patio/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 /patio/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 /patio/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 /patio/entities/veiculo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/veiculo responses: 200: description: The created resource schema: #/definitions/veiculo 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/veiculo responses: 200: description: The created resource schema: #/definitions/veiculo 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/veiculo default: description: Error response schema: #/definitions/genericError /patio/entities/veiculo/{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/veiculo responses: 200: description: Ok schema: #/definitions/veiculo 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/veiculo responses: 200: description: Ok schema: #/definitions/veiculo 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/veiculo 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 /patio/entities/veiculo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/veiculo responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /patio/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 /patio/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 /patio/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 /patio/entities/motorista: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/motorista responses: 200: description: The created resource schema: #/definitions/motorista 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/motorista responses: 200: description: The created resource schema: #/definitions/motorista 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/motorista default: description: Error response schema: #/definitions/genericError /patio/entities/motorista/{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/motorista responses: 200: description: Ok schema: #/definitions/motorista 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/motorista responses: 200: description: Ok schema: #/definitions/motorista 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/motorista 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 /patio/entities/motorista/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/motorista responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /patio/entities/controleArea: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/controleArea responses: 200: description: The created resource schema: #/definitions/controleArea 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/controleArea responses: 200: description: The created resource schema: #/definitions/controleArea 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/controleArea default: description: Error response schema: #/definitions/genericError /patio/entities/controleArea/{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/controleArea responses: 200: description: Ok schema: #/definitions/controleArea 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/controleArea responses: 200: description: Ok schema: #/definitions/controleArea 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/controleArea 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 /patio/entities/controleArea/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/controleArea responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: statusCircuito: description: Controle de execução de Circuito type: string enum: – AGUARDANDO – EXECUTANTO – CONCLUIDO – REVERTIDO – CANCELADO tipoVeiculo: description: Tipo do veiclo type: string enum: – CAVALO – CARRETA statusAgendamento: description: Status da Agenda type: string enum: – AGUARDANDO_CONFIRMACAO – AGUARDANDO_CONFIRMACAO_SOLICITANTE – AGENDADO – REJEITADO – CANCELADO – EM_EXECUCAO – CONCLUIDO tipoAtividadeTipoAgedamento: description: Informa que a Agenda Reservada é uma Descarregamento(Recebimento) ou um Carregamento(Expedição) type: string enum: – CARREGAMENTO – DESCARREGAMENTO 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 area: description: Subdivisões da Planta que possuem um objetivo específico. type: object required: – descricao – planta properties: id: type: string format: uuid description: uuid descricao: type: string description: Descrição observacao: type: string description: Observação planta: type: object allOf: – #/definitions/planta description: Planta em que a area está localizada ativo: type: boolean description: Indica se a area está ativa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vaga: description: Vaga type: object required: – descricao – area – rua – numero – ocupada properties: id: type: string format: uuid description: uuid descricao: type: string description: Descrição da vaga area: type: object allOf: – #/definitions/area description: Area da vaga rua: type: integer format: int64 description: Rua onde está a vaga numero: type: integer format: int64 description: Numero dentro da rua ocupada: type: boolean description: Identifica se a vaga esta ocupada ativo: type: boolean description: Indica se a vaga esta ativa 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: – descricao – tipoAgendamento properties: id: type: string format: uuid description: uuid descricao: type: string description: Descrição da vaga sequencias: type: array items: type: object allOf: – #/definitions/sequenciaCircuito description: sequencias tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo do agendamento do circuito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: sequenciaCircuito: description: Sequencia de execução do circuito type: object required: – descricao – area – sequencia properties: id: type: string format: uuid description: uuid descricao: type: string description: Descrição da sequencia area: type: object allOf: – #/definitions/area description: Area do circuito sequencia: type: integer format: int64 description: Posicao no circuito circuito: type: object allOf: – #/definitions/circuito description: Circuito da sequencia 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: – agenda – sequenciaCircuito – status – circuito – planta properties: id: type: string format: uuid description: uuid agenda: type: object allOf: – #/definitions/agenda description: uuid da Agenda sequenciaCircuito: type: object allOf: – #/definitions/sequenciaCircuito description: Sequencia do Circuito status: type: string allOf: – #/definitions/statusCircuito description: Status do circuito vaga: type: object allOf: – #/definitions/vaga description: Vaga alocada pelo veiculo circuito: type: object allOf: – #/definitions/circuito description: Circuito da execucao planta: type: object allOf: – #/definitions/planta description: Planta em que o circuito esta sendo executado veiculo: type: object allOf: – #/definitions/veiculo description: Veiculo do circuito motorista: type: object allOf: – #/definitions/motorista description: Motorista do circuito 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: – id – descricao – ativo – tipoAtividade properties: id: type: string description: uuid 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 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 format: uuid description: uuid nome: type: string description: Nome da planta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: veiculo: description: Veiculo type: object required: – descricao – placa – tipoVeiculo properties: id: type: string format: uuid 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: string allOf: – #/definitions/tipoVeiculo description: Tipo do veiculo Cavalo ou Carreta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: agenda: description: Replicação da agenda do portalagendamento.agenda type: object required: – id – tipoAgendamento – descricao – planta properties: id: type: string description: uuid 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 motorista: type: object allOf: – #/definitions/motorista description: Dados do Motorista veiculo: type: object allOf: – #/definitions/veiculo 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 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 – cpf – cnh properties: id: type: string format: uuid description: uuid nome: type: string description: Nome do motorista cpf: type: string description: CPF do motorista cnh: type: string description: CNH do motorista rg: type: string description: RG do motorista telefone: type: string description: Telefone do motorista contato: type: string description: Contato do motorista createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: controleArea: description: Dados do controle de areas type: object required: – areaAtual – proximaArea – vaga – veiculo – motorista – execucaoCircuito properties: id: type: string format: uuid description: ID do controle de área areaAtual: type: object allOf: – #/definitions/area description: Área atual que está chamando proximaArea: type: object allOf: – #/definitions/area description: Próxima área que o veículo deve se encaminhar vaga: type: object allOf: – #/definitions/vaga description: Vaga que o veículo deve se encaminhar veiculo: type: object allOf: – #/definitions/veiculo description: Veículo que deve se encaminhar motorista: type: object allOf: – #/definitions/motorista description: Informações do motorista do veículo execucaoCircuito: type: object allOf: – #/definitions/execucaoCircuito description: Execução do circuito que esse controle está ligado 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: 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