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

dock

32 views 0 05/07/2023 Atualizado em 03/07/2025 integrador

2.0info: 2.1.0 dock description: Gestão de Docas x-senior-domain: Controle de Pátio x-senior-domain-path: yms x-senior-service-path: dock 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: /dock/queries/loadDocksFromArea: post: description: Carrega docas com base nas vagas do á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 do pátio responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/dock description: Lista de docas em relação as vagas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Carrega docas com base nas vagas do área tags: – Queries x-senior-visibility: PRIVATE parameters: – name: areaId description: Id da área do pátio in: query required: true type: string responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/dock description: Lista de docas em relação as vagas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/dockDashboard: post: description: Dashboard status das docas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: plantId: type: string description: UUID da planta ativa responses: 200: description: Ok schema: type: object required: – percentual – available – unavailable – inProgess – inTransit – blocked – alert properties: percentual: type: number format: double description: Percentual Docas Ocupadas available: type: integer format: int64 description: Quantidade Docas disponivel (Livre) unavailable: type: integer format: int64 description: Quantidade Doca não disponível (Ocupado) inProgess: type: integer format: int64 description: Em andamento inTransit: type: integer format: int64 description: Em Transito blocked: type: integer format: int64 description: Bloqueado alert: type: integer format: int64 description: Veículo em alerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Dashboard status das docas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: plantId description: UUID da planta ativa in: query type: string responses: 200: description: Ok schema: type: object required: – percentual – available – unavailable – inProgess – inTransit – blocked – alert properties: percentual: type: number format: double description: Percentual Docas Ocupadas available: type: integer format: int64 description: Quantidade Docas disponivel (Livre) unavailable: type: integer format: int64 description: Quantidade Doca não disponível (Ocupado) inProgess: type: integer format: int64 description: Em andamento inTransit: type: integer format: int64 description: Em Transito blocked: type: integer format: int64 description: Bloqueado alert: type: integer format: int64 description: Veículo em alerta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/movementDashboard: post: description: Dashboard status das movumentações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: plantId: type: string description: UUID da planta ativa responses: 200: description: Ok schema: type: object required: – loading – unLoading properties: loading: type: integer format: int64 description: Quantidade de Carregamento unLoading: type: integer format: int64 description: Quantidade de Descarregamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Dashboard status das movumentações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: plantId description: UUID da planta ativa in: query type: string responses: 200: description: Ok schema: type: object required: – loading – unLoading properties: loading: type: integer format: int64 description: Quantidade de Carregamento unLoading: type: integer format: int64 description: Quantidade de Descarregamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/listMovementByPlant: post: description: Lista Movimentação Ativas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: plantId: type: string description: Planta das Docas ou todas se não informado currentDate: type: string format: date-time description: Data Corente ou data atual se não informado size: type: integer format: int64 description: Tamanho da página de resultados default: 10 offset: type: integer format: int64 description: Offset da página de resultador default: 0 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/movementResume description: Conteúdo do Controle de Docas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista Movimentação Ativas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: plantId description: Planta das Docas ou todas se não informado in: query type: string – name: currentDate description: Data Corente ou data atual se não informado in: query type: string format: date-time – name: size description: Tamanho da página de resultados in: query type: integer format: int64 – name: offset description: Offset da página de resultador in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/movementResume description: Conteúdo do Controle de Docas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/listDocksByPlant: post: description: Lista controle de docas por status de movimentação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: plantId: type: string description: Planta das Docas ou todas se não informado currentDate: type: string format: date-time description: Data Corente ou data atual se não informado ignoreEmpty: type: boolean description: Ignorar docas vazias default: false filter: type: object allOf: – #/definitions/movementFilter description: Filtro de pesquisa size: type: integer format: int64 description: Tamanho da página de resultados default: 10 offset: type: integer format: int64 description: Offset da página de resultador default: 0 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/dockResume description: Conteúdo do Controle de Docas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/listWaitingByPlant: post: description: Lista veiculos esperando docas na planta por status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: plantId: type: string description: Planta das Docas ou todas se não informado currentDate: type: string format: date-time description: Data Corente ou data atual se não informado filter: type: object allOf: – #/definitions/movementFilter description: Filtro de pesquisa size: type: integer format: int64 description: Tamanho da página de resultados default: 10 offset: type: integer format: int64 description: Offset da página de resultador default: 0 orderby: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – totalElements – totalPages properties: totalElements: type: integer format: int64 description: Número de elementos na lista totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/movementResume description: Conteúdo do Controle de Docas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/getDriverInfo: post: description: Retorna as informações do motorista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – movementId properties: movementId: type: string description: Id do movimento responses: 200: description: Ok schema: type: object required: – name properties: name: type: string description: Nome do motorista phone: type: string description: Telefone do motorista 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do motorista tags: – Queries x-senior-visibility: PRIVATE parameters: – name: movementId description: Id do movimento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – name properties: name: type: string description: Nome do motorista phone: type: string description: Telefone do motorista 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/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 /dock/queries/exportAreaDock: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportDock: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportMovement: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportMovementDetail: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportDockControl: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportPlanta: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportArea: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportVaga: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportMotorista: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportTipoVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportComposicaoVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportTipoAgendamento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/exportAgenda: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/setInTransit: post: description: Coloca a movimentação doca em trasito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – plate – dockName properties: plantId: type: string description: UUID da planta ativa quando necessário plate: type: string description: Placa do Veículo dockName: type: string description: Doca Selecionada startDate: type: string format: date-time description: Data Inicial ou data atual se não informado responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID da movimentação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/setInProgress: post: description: Coloca a movimentação doca em andamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – plate – dockName properties: plantId: type: string description: UUID da planta ativa quando necessário plate: type: string description: Placa do Veículo dockName: type: string description: Doca Selecionada startDate: type: string format: date-time description: Data Inicial ou data atual se não informado responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID da movimentação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/setFinished: post: description: Coloca uma movimentação ativa como finalizado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – plate properties: plantId: type: string description: UUID da planta ativa quando necessário plate: type: string description: Placa do Veículo responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID da movimentação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/setVagaInTransit: post: description: Coloca a movimentação em uma vaga em trânsito tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – plantId – vaga – plate properties: plantId: type: string description: ID da planta vaga: type: string description: ID da vaga associada a doca plate: type: string description: Placa do Veículo startDate: type: string format: date-time description: Data Inicial ou data atual se não informado responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID da movimentação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/setVagaInProgress: post: description: Coloca a movimentação vaga associada a doca em andamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – plantId – vaga – plate properties: plantId: type: string description: ID da planta vaga: type: string description: ID da vaga associada a doca plate: type: string description: Placa do Veículo startDate: type: string format: date-time description: Data Inicial ou data atual se não informado responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: ID da movimentação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/updateStatus: post: description: Movimentação das docas para um novo status tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – movementId – status – dockId properties: movementId: type: string description: UUID da movimentação status: type: string allOf: – #/definitions/movementStatus description: Status da Movimentação dockId: type: string description: UUID da doca destino startDate: type: string format: date-time description: Data Inicial ou data atual se não informado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importAreaDock: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importDock: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importMovement: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importMovementDetail: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importDockControl: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importPlanta: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importArea: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importVaga: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importMotorista: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importTipoVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importComposicaoVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importTipoAgendamento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/actions/importAgenda: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/events/dockSelected: post: description: Evento de uma doca selecionada para um movimentação de veículo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – expectedDate – plate – dockId – dockName – areaDock – ws_users properties: plantId: type: string description: UUID da planta ativa quando necessário expectedDate: type: string format: date-time description: Data Esperada / Agendamento plate: type: string description: Placa do Veículo driverName: type: string description: Nome do Motorista activityType: type: string allOf: – #/definitions/activityType description: Tipo de Atividade scheduling: type: string description: Agendamento se integrado com Pátio dockId: type: string description: ID Doca Selecionada dockName: type: string description: Nome Doca Selecionada areaDock: type: string description: ID da Area da Doca area: type: string description: ID Area do Pátio vaga: type: string description: ID Vaga do Pátio ws_users: type: string description: Usuários que vão receber a chamada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/movementStarted: post: description: Evento de nova movimentação de veículo aguardando doca iniciada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – expectedDate – plate – ws_users properties: plantId: type: string description: UUID da planta ativa quando necessário expectedDate: type: string format: date-time description: Data Esperada / Agendamento plate: type: string description: Placa do Veículo driverName: type: string description: Nome do Motorista activityType: type: string allOf: – #/definitions/activityType description: Tipo de Atividade scheduling: type: string description: Agendamento se integrado com Pátio ws_users: type: string description: Usuários que vão receber a chamada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/movementChanged: post: description: Evento de movimentação de veículo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – expectedDate – plate – status – dockId – dockName – ws_users properties: plantId: type: string description: UUID da planta ativa quando necessário expectedDate: type: string format: date-time description: Data Esperada / Agendamento plate: type: string description: Placa do Veículo driverName: type: string description: Nome do Motorista activityType: type: string allOf: – #/definitions/activityType description: Tipo de Atividade scheduling: type: string description: Agendamento se integrado com Pátio status: type: string allOf: – #/definitions/movementStatus description: Status da Movimentação dockId: type: string description: ID Doca Selecionada dockName: type: string description: Nome Doca Selecionada ws_users: type: string description: Usuários que vão receber a chamada responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importAreaDockEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportAreaDockEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importDockEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportDockEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importMovementEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportMovementEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importMovementDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportMovementDetailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importDockControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportDockControlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importPlantaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportPlantaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importAreaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportAreaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importVagaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportVagaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importMotoristaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportMotoristaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importTipoVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportTipoVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importComposicaoVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportComposicaoVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importTipoAgendamentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportTipoAgendamentoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/importAgendaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/events/exportAgendaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dock/entities/areaDock: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/areaDock responses: 200: description: The created resource schema: #/definitions/areaDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/areaDock responses: 200: description: The created resource schema: #/definitions/areaDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/areaDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/areaDock/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAreaDock responses: 200: description: Ok schema: #/definitions/editAreaDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/areaDock responses: 200: description: Ok schema: #/definitions/areaDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/areaDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/areaDock/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/areaDock responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/dock: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dock responses: 200: description: The created resource schema: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dock responses: 200: description: The created resource schema: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/dock/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDock responses: 200: description: Ok schema: #/definitions/editDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dock responses: 200: description: Ok schema: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/areaDock/{parentId}/docks: post: description: Esta entidade pode ser customizada. 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/dock responses: 200: description: The created resources schema: type: array items: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/dock responses: 200: description: The created resources schema: type: array items: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/areaDock/{parentId}/docks/{id}: put: description: Esta entidade pode ser customizada. 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/editDock responses: 200: description: Ok schema: #/definitions/editDock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dock responses: 200: description: Ok schema: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dock 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/dock/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dock responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/movement: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/movement responses: 200: description: The created resource schema: #/definitions/movement 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/movement responses: 200: description: The created resource schema: #/definitions/movement 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/movement 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/movement/{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/editMovement responses: 200: description: Ok schema: #/definitions/editMovement 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/movement responses: 200: description: Ok schema: #/definitions/movement 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/movement 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 /dock/entities/movement/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/movement responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/movementDetail: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/movementDetail responses: 200: description: The created resource schema: #/definitions/movementDetail 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/movementDetail responses: 200: description: The created resource schema: #/definitions/movementDetail 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/movementDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/movementDetail/{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/editMovementDetail responses: 200: description: Ok schema: #/definitions/editMovementDetail 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/movementDetail responses: 200: description: Ok schema: #/definitions/movementDetail 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/movementDetail 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 /dock/entities/movement/{parentId}/details: 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/movementDetail responses: 200: description: The created resources schema: type: array items: #/definitions/movementDetail 401: description: Invalid Credentials 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/movementDetail responses: 200: description: The created resources schema: type: array items: #/definitions/movementDetail 401: description: Invalid Credentials 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/movementDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/movement/{parentId}/details/{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/editMovementDetail responses: 200: description: Ok schema: #/definitions/editMovementDetail 401: description: Invalid Credentials 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/movementDetail responses: 200: description: Ok schema: #/definitions/movementDetail 401: description: Invalid Credentials 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/movementDetail 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/movementDetail/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/movementDetail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/dockControl: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dockControl responses: 200: description: The created resource schema: #/definitions/dockControl 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/dockControl responses: 200: description: The created resource schema: #/definitions/dockControl 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dockControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dock/entities/dockControl/{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/editDockControl responses: 200: description: Ok schema: #/definitions/editDockControl 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/dockControl responses: 200: description: Ok schema: #/definitions/dockControl 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/dockControl 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 /dock/entities/dockControl/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dockControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: dockType: type: string enum: – LEVEL – LIFT_DOCK – SIDE_DOCK – FRONT_DOCK – GRAVITY description: Tipos de Docas: * `LEVEL` – Doca de Nível * `LIFT_DOCK` – Doca Elevatória * `SIDE_DOCK` – Doca Carga Lateral * `FRONT_DOCK` – Doca Carga Frontal * `GRAVITY` – Doca Carga Gravidade capacityType: type: string enum: – PALLETS – WEIGHT – NET_QUANTITY description: Tipos de capacidade: * `PALLETS` – Quantidade de Paletes * `WEIGHT` – Peso em gramas * `NET_QUANTITY` – Quantidade Líquida levelerType: type: string enum: – BUILT_IN – ADVANCED – FRONT – MINI_RAMP description: Tipos de niveladora: * `BUILT_IN` – Doca Elevatória embutida * `ADVANCED` – Doca Avançada * `FRONT` – Doca Frontal * `MINI_RAMP` – Mina Rampa activityType: type: string enum: – LOADING – UNLOADING description: Tipo de Atividade: * `LOADING` – Carregamento * `UNLOADING` – Descarregamento movementStatus: type: string enum: – NONE – WAITING – IN_TRANSIT – IN_PROGESS – FINISHED description: Status da Movimentação: * `NONE` – Nenhuma movimenta / Doca Vazia * `WAITING` – Aguardando Doca: esperando receber a doca de destino * `IN_TRANSIT` – Em transito: o veiculo já encontra dentro da planta e tem uma doca definida * `IN_PROGESS` – Em andamento: o veiculo esta carregando/descarregando no momento * `FINISHED` – Finalizado, onde o veículo já saiu da doca userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim movementFilter: description: Campos para filtro da Movimentação das docas type: object properties: code: type: string description: Código da movimentação description: type: string description: Descrição da Movimentação plate: type: string description: Placa do Veículo driverName: type: string description: Motorista dockName: type: string description: Nome doca statuses: type: array items: type: string allOf: – #/definitions/movementStatus description: Status movementResume: description: Resumo da Movimentação das docas type: object properties: plate: type: string description: Placa do Veículo driverName: type: string description: Motorista activityType: type: string allOf: – #/definitions/activityType description: Tipo de Atividade status: type: string allOf: – #/definitions/movementStatus description: Status da Movimentação lastModified: type: string format: date-time description: Data Última Movimentação movementId: type: string description: Id da Movimentação dockId: type: string description: Id da Doca dockName: type: string description: Nome da Doca areaName: type: string description: Nome da Área da Doca scheduling: type: string description: Agendamento no YMS dockResume: description: Resumo da Operação de uma docas type: object required: – dockName properties: dockName: type: string description: Nome da Doca principalPlate: type: string description: Placa da Movementação Principal movements: type: array items: type: object allOf: – #/definitions/movementResume description: Movimentação Principal areaDock: description: Área da Doca type: object required: – name properties: id: type: string format: uuid description: uuid name: type: string description: Nome da Área yms: type: boolean description: Área vinculada ao Gestão de Pátio YMS default: true plant: type: object allOf: – #/definitions/planta description: Planta de Operação ou padrão se não informada area: type: object allOf: – #/definitions/area description: Área da Doca typeScheduling: type: object allOf: – #/definitions/tipoAgendamento description: Tipo de Agendamento docks: type: array items: type: object allOf: – #/definitions/dock description: Docas da Area createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAreaDock: type: object required: – id allOf: – #/definitions/areaDock dock: description: Doca type: object required: – name properties: id: type: string format: uuid description: uuid areaDock: type: object allOf: – #/definitions/areaDock description: Àrea da Doca name: type: string description: Nome da Doca type: type: string allOf: – #/definitions/dockType description: Tipo de Doca vaga: type: object allOf: – #/definitions/vaga description: Vaga do Pátio vehicleTypes: type: array items: type: object allOf: – #/definitions/tipoVeiculo description: Tipos de veículo capacityType: type: string allOf: – #/definitions/capacityType description: Tipo de capacidade valueCapacity: type: integer format: int64 description: Valor da capacidade default: 0 width: type: integer format: int64 description: Largura interna Doca (cm) default: 0 length: type: integer format: int64 description: Comprimenro interno Doca (cm) default: 0 height: type: integer format: int64 description: Altura interno Doca (cm) default: 0 doorWidth: type: integer format: int64 description: Largura Porta da Doca (cm) default: 0 doorHeight: type: integer format: int64 description: Altura Porta da Doca (cm) default: 0 floorHeight: type: integer format: int64 description: Altura da Doca em relação ao piso (cm) default: 0 levelerType: type: string allOf: – #/definitions/levelerType description: Tipo de niveladora securiyInfo: type: string maxLength: 255 description: Instruções de segurança loadInfo: type: string maxLength: 255 description: Instruções de manuseio de carga exitInfo: type: string maxLength: 255 description: Instruções de saída da doca createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDock: type: object required: – id allOf: – #/definitions/dock movement: description: Movimentação type: object required: – description – activityType – expectedDate – plate properties: id: type: string format: uuid description: uuid code: type: string description: Código da Movimentação como o número expedição ou agenda description: type: string description: Descrição da Movimentação activityType: type: string allOf: – #/definitions/activityType description: Atividade da Movimentação expectedDate: type: string format: date-time description: Data Esperada / Agendamento plate: type: string description: Placa do Veículo driverName: type: string description: Nome do Motorista plant: type: object allOf: – #/definitions/planta description: Planta de Operação ou planta padrão se não informada scheduling: type: object allOf: – #/definitions/agenda description: Agenda em execução no Gestão do Pátio details: type: array items: type: object allOf: – #/definitions/movementDetail description: Detalhes da Movimentação docks: type: array items: type: object allOf: – #/definitions/dockControl description: Docas Transitadas createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMovement: type: object required: – id allOf: – #/definitions/movement movementDetail: description: Detalhes da Movimentação type: object required: – status properties: id: type: string format: uuid description: uuid movement: type: object allOf: – #/definitions/movement description: Movimentação status: type: string allOf: – #/definitions/movementStatus description: Status da Movimentação startDate: type: string format: date-time description: Data Inicial da Movimentação endDate: type: string format: date-time description: Data Final da Movimentação currentDock: type: object allOf: – #/definitions/dock description: Doca Atual se informado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMovementDetail: type: object required: – id allOf: – #/definitions/movementDetail dockControl: description: Controle das docas type: object required: – dock properties: id: type: string format: uuid description: uuid dock: type: object allOf: – #/definitions/dock description: Doca inProgress: type: object allOf: – #/definitions/movement description: Movimentação em Andamento inTransit: type: array items: type: object allOf: – #/definitions/movement description: Movumentação em transito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDockControl: type: object required: – id allOf: – #/definitions/dockControl planta: description: Entidade externa Agenda type: object properties: id: type: string format: uuid description: uuid nome: type: string description: Nome da planta extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: area: description: Entidade externa Area type: object properties: id: type: string format: uuid description: uuid descricao: type: string description: Descrição planta: type: object allOf: – #/definitions/planta description: Planta em que a area está localizada ativo: type: boolean description: Indica se a área esta ativa extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vaga: description: Entidade externa Vaga type: object 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 ativo: type: boolean description: Indica se a vaga esta ativa deleted: type: boolean description: Indicação registro deletado default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: motorista: description: Entidade externa motorista type: object properties: id: type: string format: uuid description: uuid nome: type: string description: Nome do motorista telefone: type: string description: Telefone do motorista excluido: type: boolean description: Indica se o veículo foi excluído logicamente default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoVeiculo: description: Entidade External Tipo do Veículo type: object properties: id: type: string format: uuid description: ID descricao: type: string description: Descrição do tipo de veículo extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: veiculo: description: Entidade externa Veiculo type: object properties: id: type: string format: uuid description: uuid descricao: type: string description: Descrição do veiculo placa: type: string description: Placa do veiculo excluido: type: boolean description: Indica se o veículo foi excluído logicamente default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: composicaoVeiculo: description: Entidade externa Composição de veículos type: object properties: id: type: string format: uuid description: ID da composição descricao: type: string description: Descrição da composição primario: type: object allOf: – #/definitions/veiculo description: Veículo primário eixos: type: integer format: int64 description: Eixos default: 0 excluido: type: boolean description: Indica se o veículo foi excluído logicamente default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoAgendamento: description: Entidade externa Tipo de Agendamento type: object properties: id: type: string format: uuid description: uuid codigo: type: string description: Código Identificador do Tipo de Agendamento descricao: type: string description: Descrição do Tipo Agendamento ativo: type: boolean description: Indica se o Tipo de Agendamento está ativo extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: agenda: description: Entidade externa Agenda type: object properties: id: type: string format: uuid description: Id da Agenda codigo: type: integer format: int64 description: Código identificador da agenda tipoAgendamento: type: object allOf: – #/definitions/tipoAgendamento description: Tipo do Agendamento descricao: type: string description: Descrição do Agendamento dataEsperadaAgendamento: type: string format: date-time description: Data Esperada de Inicio do Agendamento planta: type: object allOf: – #/definitions/planta description: Planta Associada motorista: type: object allOf: – #/definitions/motorista description: Dados do Motorista veiculo: type: object allOf: – #/definitions/composicaoVeiculo description: dados do Veículo status: type: string description: Status Agendamento extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

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