Gestão de Pátio (yms)

integration

3 views 04/08/2020 04/11/2020 integrador 0

2.0info: 1.2.0 integration description: Serviço de integração do YMS x-senior-domain: Controle de Pátio x-senior-domain-path: yms x-senior-service-path: integration contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/ymssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /integration/queries/statusGate: post: description: Obtém o status da cancela tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ip properties: ip: type: string description: IP de localização da cancela responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: Status da cancela default: description: Error response schema: #/definitions/genericError get: description: Obtém o status da cancela tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ip description: IP de localização da cancela in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: Status da cancela default: description: Error response schema: #/definitions/genericError /integration/queries/statusGateWithApiKey: post: description: Obtém o status da cancela com chave de API tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ip – apiKey properties: ip: type: string description: IP de localização da cancela apiKey: type: string description: Chave da API pra Cancela responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: Status da cancela default: description: Error response schema: #/definitions/genericError get: description: Obtém o status da cancela com chave de API tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ip description: IP de localização da cancela in: query required: true type: string – name: apiKey description: Chave da API pra Cancela in: query required: true type: string responses: 200: description: Ok schema: type: object required: – status properties: status: type: string description: Status da cancela default: description: Error response schema: #/definitions/genericError /integration/queries/listIntegrations: post: description: Retorna todas as integrações ativas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – integrations properties: integrations: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Lista de integrações ativas default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as integrações ativas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – integrations properties: integrations: type: array items: type: object allOf: – #/definitions/integration minimum: 1 description: Lista de integrações ativas default: description: Error response schema: #/definitions/genericError /integration/queries/fetchSnapshot: post: description: Obtém uma foto a partir da câmera especificada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ip properties: ip: type: string description: IP de localização da câmera width: type: integer format: int64 description: Largura da imagem height: type: integer format: int64 description: Altura da imagem responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL de localização da imagem obtida default: description: Error response schema: #/definitions/genericError get: description: Obtém uma foto a partir da câmera especificada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ip description: IP de localização da câmera in: query required: true type: string – name: width description: Largura da imagem in: query type: integer format: int64 – name: height description: Altura da imagem in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL de localização da imagem obtida default: description: Error response schema: #/definitions/genericError /integration/queries/getErpProcessConfigurationByTipoAgendamento: post: description: Obtém uma Configuração de processo do ERP a partir do Tipo de Agendamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idTipoAgendamento properties: idTipoAgendamento: type: string description: ID do Tipo de Agendamento responses: 200: description: Ok schema: type: object allOf: – #/definitions/erpProcessConfiguration default: description: Error response schema: #/definitions/genericError get: description: Obtém uma Configuração de processo do ERP a partir do Tipo de Agendamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idTipoAgendamento description: ID do Tipo de Agendamento in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/erpProcessConfiguration default: description: Error response schema: #/definitions/genericError /integration/queries/desktopPrivateKey: post: description: Recupera uma chave privada para acesso de dados criptografados no aplicativo desktop yms-balança tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – privateKey properties: privateKey: type: string description: Chave privada do aplicativo default: description: Error response schema: #/definitions/genericError get: description: Recupera uma chave privada para acesso de dados criptografados no aplicativo desktop yms-balança tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – privateKey properties: privateKey: type: string description: Chave privada do aplicativo default: description: Error response schema: #/definitions/genericError /integration/queries/getWeightScaleBrokerSetup: post: description: Retorna os dados de configuração do broker iniciar serviço balança tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – config properties: config: type: string format: byte description: Dados de Configuração do Broker para Balança default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados de configuração do broker iniciar serviço balança tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – config properties: config: type: string format: byte description: Dados de Configuração do Broker para Balança default: description: Error response schema: #/definitions/genericError /integration/queries/getLastValidPlateByLpr: post: description: Retorna a última placa válida lida pelo LPR. A validação ocorre através da configuração do LPR Tempo entre leitura.\n Caso a data e hora da última placa lida pelo LPR for maior que o tempo entre leitura configurado, a query identifica que é uma placa muito antiga e não a retorna. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – stream properties: stream: type: string description: Código único do LPR responses: 200: description: Ok schema: type: object required: – plate properties: plate: type: string description: última placa válida lida pelo LPR default: description: Error response schema: #/definitions/genericError get: description: Retorna a última placa válida lida pelo LPR. A validação ocorre através da configuração do LPR Tempo entre leitura.\n Caso a data e hora da última placa lida pelo LPR for maior que o tempo entre leitura configurado, a query identifica que é uma placa muito antiga e não a retorna. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: stream description: Código único do LPR in: query required: true type: string responses: 200: description: Ok schema: type: object required: – plate properties: plate: type: string description: última placa válida lida pelo LPR default: description: Error response schema: #/definitions/genericError /integration/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportGate: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportLprConfiguration: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportLprRegister: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportWeightScale: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportWeightScaleRegister: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportCamera: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportLobby: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportPlatePicture: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportErpProcessConfiguration: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportPlanta: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportArea: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/exportTipoAgendamento: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /integration/actions/lprEventPublish: post: description: Informa para o YMS que uma placa foi lida pelo sistema de LPR.\n Grava na base de dados o LPR e placa lida.\n E notifica os interessados registrados pela primitiva `lprEventSubscribe`.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – stream – licencePlate properties: stream: type: string description: Identificador do fluxo que gerou a leitura da placa licencePlate: type: string description: Valor da placa que foi identificada responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /integration/actions/lprEventPublishWithApiKey: post: description: Informa para o YMS que uma placa foi lida pelo sistema de LPR usando chave de api\n Grava na base de dados o LPR e placa lida.\n E notifica os interessados registrados pela primitiva `lprEventSubscribe`.\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – stream – licencePlate – apiKey properties: stream: type: string description: Identificador do fluxo que gerou a leitura da placa licencePlate: type: string description: Valor da placa que foi identificada apiKey: type: string description: Chave da API pra LPR responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /integration/actions/openGate: post: description: Aciona o comando de abrir cancela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ip properties: ip: type: string description: IP de localização da cancela responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem de resposta da cancela default: description: Error response schema: #/definitions/genericError /integration/actions/closeGate: post: description: Aciona o comando de fechar cancela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ip properties: ip: type: string description: IP de localização da cancela responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem de resposta da cancela default: description: Error response schema: #/definitions/genericError /integration/actions/setGateEmergencyMode: post: description: Aciona o modo emergência da cancela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ip properties: ip: type: string description: IP de localização da cancela responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem de resposta da cancela default: description: Error response schema: #/definitions/genericError /integration/actions/setGateDefaultMode: post: description: Aciona o modo padrão da cancela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ip properties: ip: type: string description: IP de localização da cancela responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Mensagem de resposta da cancela default: description: Error response schema: #/definitions/genericError /integration/actions/executeLobby: post: description: Executa a entrada do veículo na portaria. Esta ação:\n 1. Valida se a balança vinculada está livre (Peso zero ou dentro da tolerância);\n 2. Tira foto se tiver câmera vinculada; A foto fica salva e enviada ao ERP G5 durante a execução do circuito;\n 3. Abre a cancela;\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lobbyId – plate properties: lobbyId: type: string description: Id da portaria plate: type: string description: Placa responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /integration/actions/importGate: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importLprConfiguration: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importLprRegister: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importWeightScale: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importWeightScaleRegister: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importCamera: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importLobby: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importPlatePicture: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importErpProcessConfiguration: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importPlanta: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importArea: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/actions/importTipoAgendamento: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /integration/signals/lprEventSubscribe: post: description: Quando um veículo chega em uma determinada área, o leitor LPR o identifica e envia um sinal de reconhecimento para esse serviço de integração.\n Ao chamar esse sinal, o serviço de integração enviará para a `rotina` da Execução Circuito a próxima placa reconhecida pelo leitor LPR.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – stream – execucaoCircuitoId – licencePlate properties: stream: type: string description: Identificador do fluxo LPR (Câmera, Vídeo, Foto) execucaoCircuitoId: type: string description: ID da Execução Circuito que irá receber o valor da próxima placa control: type: string description: Identificador de um controlador específico licencePlate: type: string description: Placa do veículo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/lprRead: post: description: Informa para o YMS que uma placa foi lida pelo sistema de LPR.\n Este signal apenas grava na base de dados o LPR e a placa que foram lidos. Nenhum evento é emitido.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – stream – licencePlate properties: stream: type: string description: Identificador do fluxo que gerou a leitura da placa licencePlate: type: string description: Valor da placa que foi identificada responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/lprReadWithApiKey: post: description: Informa para o YMS que uma placa foi lida pelo sistema de LPR usando chave de api\n Este signal apenas grava na base de dados o LPR e a placa que foram lidos. Nenhum evento é emitido.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – stream – licencePlate – apiKey properties: stream: type: string description: Identificador do fluxo que gerou a leitura da placa licencePlate: type: string description: Valor da placa que foi identificada apiKey: type: string description: Chave da API pra LPR responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/weightEventSubscribe: post: description: Ao chamar esse sinal, o serviço de integração enviará para a `rotina` da Execução Circuito o próximo peso lido pela balança. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – weightScaleCode – execucaoCircuitoId properties: weightScaleCode: type: string description: Código identificador da balança execucaoCircuitoId: type: string description: ID da Execução Circuito que irá receber o valor da balança control: type: string description: Identificador de um controlador específico responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/weightEventPublish: post: description: Informa para o YMS uma leitura de balança manual.\n Ao receber o valor do peso o YMS notifica os interessados registrados pelada primitiva `weightEventSubscribe`.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – weightScaleCode – weight properties: weightScaleCode: type: string description: Identificador da balança que fez a leitura do peso weight: type: number format: double description: Valor do peso responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/lprLock: post: description: Bloqueia a operação no LPR. Quando bloqueado, o sistema não responderá aos estímulos das leituras de placa que são enviadas. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – stream properties: stream: type: string description: Código único do LPR responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/lprUnlock: post: description: Desbloqueia a operação no LPR. Quando desbloqueado, o sistema responderá aos estímulos das leituras de placa que são enviadas, podendo avançar o circuito. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – stream properties: stream: type: string description: Código único do LPR responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/lprKeepLocked: post: description: Valida se algum LPR configurado para se manter bloqueado ficou disponível além do tempo limite passado pelo parâmetro seconds.\n Caso algum LPR seja identificado nesta situação será feito o bloqueio novamente. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – seconds properties: seconds: type: integer format: int64 description: Limite de tempo que o LPR pode ficar desbloqueado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/entities/gate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/gate responses: 200: description: The created resource schema: #/definitions/gate 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/gate responses: 200: description: The created resource schema: #/definitions/gate default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/gate default: description: Error response schema: #/definitions/genericError /integration/entities/gate/{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/gate responses: 200: description: Ok schema: #/definitions/gate 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/gate responses: 200: description: Ok schema: #/definitions/gate 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/gate default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/gate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/gate responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/lprConfiguration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lprConfiguration responses: 200: description: The created resource schema: #/definitions/lprConfiguration 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/lprConfiguration responses: 200: description: The created resource schema: #/definitions/lprConfiguration default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lprConfiguration default: description: Error response schema: #/definitions/genericError /integration/entities/lprConfiguration/{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/lprConfiguration responses: 200: description: Ok schema: #/definitions/lprConfiguration 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/lprConfiguration responses: 200: description: Ok schema: #/definitions/lprConfiguration 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/lprConfiguration default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/lprConfiguration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lprConfiguration responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/lprRegister: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lprRegister responses: 200: description: The created resource schema: #/definitions/lprRegister 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/lprRegister responses: 200: description: The created resource schema: #/definitions/lprRegister default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lprRegister default: description: Error response schema: #/definitions/genericError /integration/entities/lprRegister/{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/lprRegister responses: 200: description: Ok schema: #/definitions/lprRegister 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/lprRegister responses: 200: description: Ok schema: #/definitions/lprRegister 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/lprRegister default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/lprRegister/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lprRegister responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/weightScale: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/weightScale responses: 200: description: The created resource schema: #/definitions/weightScale 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/weightScale responses: 200: description: The created resource schema: #/definitions/weightScale default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/weightScale default: description: Error response schema: #/definitions/genericError /integration/entities/weightScale/{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/weightScale responses: 200: description: Ok schema: #/definitions/weightScale 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/weightScale responses: 200: description: Ok schema: #/definitions/weightScale 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/weightScale default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/weightScale/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/weightScale responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/weightScaleRegister: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/weightScaleRegister responses: 200: description: The created resource schema: #/definitions/weightScaleRegister 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/weightScaleRegister responses: 200: description: The created resource schema: #/definitions/weightScaleRegister default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/weightScaleRegister default: description: Error response schema: #/definitions/genericError /integration/entities/weightScaleRegister/{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/weightScaleRegister responses: 200: description: Ok schema: #/definitions/weightScaleRegister 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/weightScaleRegister responses: 200: description: Ok schema: #/definitions/weightScaleRegister 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/weightScaleRegister default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/weightScaleRegister/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/weightScaleRegister responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/camera: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/camera responses: 200: description: The created resource schema: #/definitions/camera 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/camera responses: 200: description: The created resource schema: #/definitions/camera default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/camera default: description: Error response schema: #/definitions/genericError /integration/entities/camera/{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/camera responses: 200: description: Ok schema: #/definitions/camera 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/camera responses: 200: description: Ok schema: #/definitions/camera 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/camera default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/camera/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/camera responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/lobby: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lobby responses: 200: description: The created resource schema: #/definitions/lobby 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/lobby responses: 200: description: The created resource schema: #/definitions/lobby default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lobby default: description: Error response schema: #/definitions/genericError /integration/entities/lobby/{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/lobby responses: 200: description: Ok schema: #/definitions/lobby 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/lobby responses: 200: description: Ok schema: #/definitions/lobby 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/lobby default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/lobby/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lobby responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/platePicture: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/platePicture responses: 200: description: The created resource schema: #/definitions/platePicture 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/platePicture responses: 200: description: The created resource schema: #/definitions/platePicture default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/platePicture default: description: Error response schema: #/definitions/genericError /integration/entities/platePicture/{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/platePicture responses: 200: description: Ok schema: #/definitions/platePicture 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/platePicture responses: 200: description: Ok schema: #/definitions/platePicture 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/platePicture default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/platePicture/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/platePicture responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/erpProcessConfiguration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/erpProcessConfiguration responses: 200: description: The created resource schema: #/definitions/erpProcessConfiguration 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/erpProcessConfiguration responses: 200: description: The created resource schema: #/definitions/erpProcessConfiguration default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/erpProcessConfiguration default: description: Error response schema: #/definitions/genericError /integration/entities/erpProcessConfiguration/{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/erpProcessConfiguration responses: 200: description: Ok schema: #/definitions/erpProcessConfiguration 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/erpProcessConfiguration responses: 200: description: Ok schema: #/definitions/erpProcessConfiguration 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/erpProcessConfiguration default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /integration/entities/erpProcessConfiguration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/erpProcessConfiguration responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /integration/entities/planta: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/planta default: description: Error response schema: #/definitions/genericError /integration/entities/planta/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/planta default: description: Error response schema: #/definitions/genericError /integration/entities/area: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/area default: description: Error response schema: #/definitions/genericError /integration/entities/area/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/area default: description: Error response schema: #/definitions/genericError /integration/entities/tipoAgendamento: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError /integration/entities/tipoAgendamento/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tipoAgendamento default: description: Error response schema: #/definitions/genericError definitions: gateType: description: Tipo da cancela type: string enum: – ENTRY – EXIT processType: description: Tipo de Processo type: string enum: – RECEBIMENTO_CONTRATO – RECEBIMENTO_ORDEM_COMPRA – EXPEDICAO – DEVOLUCAO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR integration: description: Integrações que podem ser ativas pelo usuário type: object required: – name properties: name: type: string description: Nome/chave da integração configurada no PDL gate: description: Cancela type: object required: – ip – type – area properties: id: type: string format: uuid description: ID ip: type: string description: IP da cancela type: type: string allOf: – #/definitions/gateType description: Tipo da cancela area: type: object allOf: – #/definitions/area description: Área que a cancela se encontra active: type: boolean description: Indica se a cancela está ativa default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: lprConfiguration: description: Configurações LPR type: object required: – stream – area properties: id: type: string format: uuid description: ID stream: type: string description: Identificador do fluxo (Câmera, Vídeo, Foto) area: type: object allOf: – #/definitions/area description: Área em que o lpr está monitorando locked: type: boolean description: Operação bloqueada default: false keepLocked: type: boolean description: Manter LPR com operação bloqueada? default: false unlockDate: type: string format: date-time description: Data do último desbloqueio da operação executeWhenUnlock: type: boolean description: Indica se avança o circuito quando for desbloqueado o LPR default: true timeBetweenRead: type: integer format: int64 description: Tempo em segundos entre leituras de placa active: type: boolean description: Indica se a configuração de lpr está ativa default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: lprRegister: description: Armazena a última placa lida por determinado LPR type: object required: – stream – plate – readingDate properties: stream: type: string description: Código que identifica o LPR plate: type: string description: Placa capturada readingDate: type: string format: date-time description: Data/hora de leitura createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: weightScale: description: Balança type: object required: – code – description – area properties: id: type: string format: uuid description: ID code: type: string description: Código que identifica a balança description: type: string description: Descrição area: type: object allOf: – #/definitions/area description: Área vinculada tolerance: type: number format: double description: Tolerância para determinar que o veículo saiu da balança createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: weightScaleRegister: description: Armazena o último peso registrado pela balança type: object required: – code – weight properties: code: type: string description: Código que identifica a balança weight: type: number format: double description: Peso capturado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: camera: description: Câmera type: object required: – description – ip – username – password – area properties: id: type: string format: uuid description: ID description: type: string description: Descrição ip: type: string description: IP username: type: string description: Usuário de acesso password: type: string description: Senha de acesso area: type: object allOf: – #/definitions/area description: Área vinculada active: type: boolean description: Indica se a câmera está ativa default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: lobby: description: Portaria type: object required: – description – planta properties: id: type: string format: uuid description: ID description: type: string description: Descrição da portaria planta: type: object allOf: – #/definitions/planta description: Planta entranceGate: type: object allOf: – #/definitions/gate description: Cancela de entrada entranceLpr: type: object allOf: – #/definitions/lprConfiguration description: LPR de entrada entranceCamera: type: object allOf: – #/definitions/camera description: Câmera de entrada entranceWeightScale: type: object allOf: – #/definitions/weightScale description: Balança de entrada lprs: type: array items: type: object allOf: – #/definitions/lprConfiguration description: Outros LPRs que serão gerenciados createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: platePicture: description: Fotos das placas type: object required: – plate – url – camera properties: id: type: string format: uuid description: ID plate: type: string description: Placa url: type: string description: URL da foto camera: type: object allOf: – #/definitions/camera description: Câmera execucaoCircuitoId: type: string maxLength: 36 description: Id da execução do circuito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: erpProcessConfiguration: description: Configuração do processo do erp type: object required: – tipos properties: id: type: string description: ID do processo de configuração no ERP tipos: type: array items: type: object allOf: – #/definitions/tipoAgendamento minimum: 1 description: Tipos de agendamento no processo de configuração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: planta: description: Planta de operação type: object required: – nome properties: id: type: string format: uuid description: uuid nome: type: string description: Nome da planta cnpj: type: array items: type: string description: Lista de CNPJs vinculados a planta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: area: description: Subdivisões da Planta que possuem um objetivo específico. type: object required: – descricao – planta properties: id: type: string format: uuid description: ID da área descricao: type: string description: Descrição da área planta: type: object allOf: – #/definitions/planta description: Planta em que a area está localizada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoAgendamento: description: Tipo de agendamento type: object required: – descricao – codigo – tipoAtividade properties: id: type: string format: uuid description: ID do tipo de agendamento descricao: type: string description: Descrição do tipo de agendamento codigo: type: string description: Código do tipo de agendamento tipoAtividade: type: string description: Tipo de atividade do tipo de agendamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment