agro_events

2.0info: 1.4.1 agro_events description: Controle de Eventos do Agro x-senior-domain: agro x-senior-domain-path: agro x-senior-service-path: agro_events 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/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /agro_events/queries/healthcheck: post: description: Health Check tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: object allOf: – #/definitions/checkData description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Health Check tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: object allOf: – #/definitions/checkData description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/queries/getCurrentProcessingEvent: post: description: DOC tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventGroupId properties: eventGroupId: type: string description: Id do grupo de eventos responses: 200: description: Ok schema: type: object properties: eventControlItemId: type: string description: Id do item de controle de eventos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: DOC tags: – Queries x-senior-visibility: PRIVATE parameters: – name: eventGroupId description: Id do grupo de eventos in: query required: true type: string responses: 200: description: Ok schema: type: object properties: eventControlItemId: type: string description: Id do item de controle de eventos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/queries/listDistinctControlCodes: post: description: Query chamada pelo lookup Identificador, mostrando controlCodes não duplicados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtro de código size: type: integer format: int64 description: Quantidade de itens por página default: 10 offset: type: integer format: int64 description: Paginação default: 0 orderby: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/controlCodeList minimum: 1 description: Resultado da query totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query chamada pelo lookup Identificador, mostrando controlCodes não duplicados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filter description: Filtro de código in: query type: string – name: size description: Quantidade de itens por página in: query type: integer format: int64 – name: offset description: Paginação in: query type: integer format: int64 – name: orderby description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/controlCodeList minimum: 1 description: Resultado da query totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/queries/listEventControlWithFilters: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Quantidade de itens por página default: 10 page: type: integer format: int64 description: Paginação default: 0 companyId: type: string description: Id da empresa branchId: type: string description: Id da filial controlCode: type: array items: type: integer format: int64 description: Código de controle eventOrigin: type: string allOf: – #/definitions/eventOrigin description: Origem do evento eventStatus: type: string allOf: – #/definitions/eventStatus description: Status do evento externalId: type: string description: Id externo createdDateStart: type: string format: date-time description: Data de criação inicial createdDateEnd: type: string format: date-time description: Data de criação final order: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – contents – totalElements – totalPages properties: contents: type: array items: type: object allOf: – #/definitions/eventControl minimum: 1 description: conteudo totalElements: type: integer format: int64 description: Total de registros totalPages: type: integer format: int64 description: Total de paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/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 /agro_events/queries/exportE070emp: 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 /agro_events/queries/exportE070fil: 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 /agro_events/queries/exportEventControl: 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 /agro_events/queries/exportEventControlItem: 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 /agro_events/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 /agro_events/actions/createEvents: post: description: Endpoint genérico de criação de eventos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventControl – eventControlItems properties: eventControl: type: object allOf: – #/definitions/eventControlReceived description: Entidade Cabeçalho dos Eventos eventControlItems: type: array items: type: object allOf: – #/definitions/eventControlItemReceived minimum: 1 description: Lista de itens de controle de eventos responses: 200: description: Ok schema: type: object required: – eventControlId properties: eventControlId: type: string description: Id do evento criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/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 /agro_events/actions/importE070emp: 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 /agro_events/actions/importE070fil: 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 /agro_events/actions/importEventControl: 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 /agro_events/actions/importEventControlItem: 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 /agro_events/signals/signalStatusEvent: post: description: Esse endpoint verifica o status dos eventos que estão travados como processando e os muda para falha tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /agro_events/signals/reprocessFailedEvent: post: description: Esse endpoint recebe o id do item de evento que está com o status FAILED, altera para PENDING e executa o reprocessamento do evento genérico tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventControlItemId properties: eventControlItemId: type: string description: Id do Item de Controle de eventos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /agro_events/signals/setProcessingStatus: post: description: Sinal indicando que o evento está sendo processado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventControlItemId properties: eventControlItemId: type: string description: Id do item de controle de eventos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /agro_events/signals/setSuccessStatus: post: description: Sinal indicando que o evento foi processado com sucesso tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventControlItemId properties: eventControlItemId: type: string description: Id do item de controle de eventos message: type: string description: Mensagem informativa para registro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /agro_events/signals/setFailedStatus: post: description: Sinal indicando que o evento falhou tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventControlItemId – message properties: eventControlItemId: type: string description: Id do item de controle de eventos message: type: string description: Mensagem informativa para registro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /agro_events/events/processedEvent: post: description: Evento genérico indicando que teve alteração em algum tipo de evento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – status – eventOperation – eventControlId – eventControlItemId – externalId properties: message: type: string description: Mensagem status: type: string allOf: – #/definitions/eventStatus description: Status do evento eventOperation: type: string allOf: – #/definitions/eventOperation description: Tipo da operação do evento eventControlId: type: string description: Id do controle de eventos eventControlItemId: type: string description: Id do item de controle de eventos externalId: type: string description: Id externo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /agro_events/events/allEventsProcessed: post: description: Evento genérico indicando que o evento contido no payload foi totalmente processado com sucesso x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – companyId – branchId – eventOrigin – externalId properties: id: type: string description: Id da entidade companyId: type: string description: Empresa branchId: type: string description: Filial eventOrigin: type: string allOf: – #/definitions/eventOrigin description: Origem do evento externalId: type: string description: Id externo controlCode: type: integer format: int64 description: Código de controle da origem do evento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /agro_events/events/importE070empEvent: 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 /agro_events/events/exportE070empEvent: 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 /agro_events/events/importE070filEvent: 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 /agro_events/events/exportE070filEvent: 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 /agro_events/events/importEventControlEvent: 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 /agro_events/events/exportEventControlEvent: 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 /agro_events/events/importEventControlItemEvent: 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 /agro_events/events/exportEventControlItemEvent: 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 /agro_events/entities/e070emp: 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/e070emp/{id}: 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/e070fil: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/e070fil/{id}: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/eventControl: 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/eventControl responses: 200: description: The created resource schema: #/definitions/eventControl 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/eventControl responses: 200: description: The created resource schema: #/definitions/eventControl 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/eventControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/eventControl/{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/editEventControl responses: 200: description: Ok schema: #/definitions/editEventControl 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/eventControl responses: 200: description: Ok schema: #/definitions/eventControl 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/eventControl 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 /agro_events/entities/eventControl/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/eventControlItem: 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/eventControlItem responses: 200: description: The created resource schema: #/definitions/eventControlItem 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/eventControlItem responses: 200: description: The created resource schema: #/definitions/eventControlItem 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/eventControlItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/eventControlItem/{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/editEventControlItem responses: 200: description: Ok schema: #/definitions/editEventControlItem 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/eventControlItem responses: 200: description: Ok schema: #/definitions/eventControlItem 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/eventControlItem 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 /agro_events/entities/eventControl/{parentId}/eventControlItem: 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/eventControlItem responses: 200: description: The created resources schema: type: array items: #/definitions/eventControlItem 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/eventControlItem responses: 200: description: The created resources schema: type: array items: #/definitions/eventControlItem 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/eventControlItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /agro_events/entities/eventControl/{parentId}/eventControlItem/{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/editEventControlItem responses: 200: description: Ok schema: #/definitions/editEventControlItem 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/eventControlItem responses: 200: description: Ok schema: #/definitions/eventControlItem 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/eventControlItem 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 /agro_events/entities/eventControlItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventControlItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down eventOrigin: type: string enum: – BALANCE_ENTRY_CONTROL – TRANSFER – FIXATION – CANCEL_FIXATION – TRANSFER_CANCELLATION – AGRONOMIC_PRESCRIPTION – PRESCRIPTION_INTEGRATION_HUB description: Evento de origem: * `BALANCE_ENTRY_CONTROL` – Controle de balança * `TRANSFER` – Transferência * `FIXATION` – Fixação * `CANCEL_FIXATION` – Cancela Fixação * `TRANSFER_CANCELLATION` – Cancelamento da transferência * `AGRONOMIC_PRESCRIPTION` – Receituário Agronômico * `PRESCRIPTION_INTEGRATION_HUB` – Integrador do Receituário Agronômico eventOperation: type: string enum: – ORIGINATION_CREATE_PROVISIONAL_BALANCE – ORIGINATION_CREATE_EFFECTIVE_BALANCE – ORIGINATION_CREATE_INVOICE – INVOICE_CANCEL_INVOICE – REPROCESS_ORIGINATION_INVOICE – PRODUCER_NET_VALUE_EFFECTIVE_BALANCE_CONFIRMATION – CHANGE_REQUEST – CHANGE_RESPONSE – PROCESS_FIXATION – TRANSFER_CREATE_INCOMING_INVOICE – TRANSFER_CREATE_OUTGOING_INVOICE – TRANSFER_PRODUCER_BALANCE – FINISH_FINANCIAL_FIXATION – FINISH_PRODUCER_NET_VALUE_FIXATION – CONCLUDE_FIXATION – CANCEL_FINANCIAL_FIXATION – CANCEL_PRODUCER_NET_VALUE_FIXATION – CANCEL_FIXATION – TRANSFER_CANCEL_INCOMING_INVOICE – TRANSFER_CANCEL_OUTGOING_INVOICE – TRANSFER_REVERSE_PRODUCER_BALANCE – TRANSFER_CONCLUDE_CANCEL – SIS_DEV_INTEGRATION – CLOSE_INVOICE_AGRONOMIC_PRESCRIPTION – CREATE_INVOICE_FIXATION – CANCEL_INVOICE_FIXATION – CLOSE_INVOICE_FIXATION – PRESCRIPTION_DATA_LOAD – CLOSE_INVOICE_TRANSFER – REOPEN_INVOICE_TRANSFER – TRANSFER_CREATE_FINANCIAL_TITLE – TRANSFER_CANCEL_FINANCIAL_TITLE – TRANSFER_CREATE_SERVICE_INVOICE – TRANSFER_CANCEL_SERVICE_INVOICE – REOPEN_INVOICE_FIXATION description: Tipo da operação do evento: * `ORIGINATION_CREATE_PROVISIONAL_BALANCE` – Criação do saldo provisório pelo processo de originação * `ORIGINATION_CREATE_EFFECTIVE_BALANCE` – Criação do saldo efetivo pelo processo de originação * `ORIGINATION_CREATE_INVOICE` – Criação da nota fiscal pelo processo de originação * `INVOICE_CANCEL_INVOICE` – Solicitação de cancelamento da nota fiscal pelo processo da NF * `REPROCESS_ORIGINATION_INVOICE` – Solicitação de reprocessamento da nota fiscal pelo processo de originação * `PRODUCER_NET_VALUE_EFFECTIVE_BALANCE_CONFIRMATION` – Confirmação do saldo efetivo pelo processo de saldo do produtor * `CHANGE_REQUEST` – Solicitação de alteração * `CHANGE_RESPONSE` – Resposta da solicitação de alteração * `PROCESS_FIXATION` – Processa a fixação * `TRANSFER_CREATE_INCOMING_INVOICE` – Criação da nota fiscal de entrada da transferência * `TRANSFER_CREATE_OUTGOING_INVOICE` – Criação da nota fiscal de saida da transferência * `TRANSFER_PRODUCER_BALANCE` – Transferência de saldo entre produtores * `FINISH_FINANCIAL_FIXATION` – Finalização do financeiro da fixação * `FINISH_PRODUCER_NET_VALUE_FIXATION` – Finaliza saldo do produto na fixação * `CONCLUDE_FIXATION` – Conclui fixação após todos eventos finalizarem * `CANCEL_FINANCIAL_FIXATION` – Cancela financeiro * `CANCEL_PRODUCER_NET_VALUE_FIXATION` – Cancela producer_net_value * `CANCEL_FIXATION` – Cancela fixação * `TRANSFER_CANCEL_INCOMING_INVOICE` – Cancelamento da nota fiscal de transferencia * `TRANSFER_CANCEL_OUTGOING_INVOICE` – Cancelamento da nota fiscal de saida da transferencia * `TRANSFER_REVERSE_PRODUCER_BALANCE` – Estorno da transferência entre produtores * `TRANSFER_CONCLUDE_CANCEL` – Conclui cancelamento da transferencia * `SIS_DEV_INTEGRATION` – Integração com o SisDev * `CLOSE_INVOICE_AGRONOMIC_PRESCRIPTION` – Fecha notas fiscais no receituário * `CREATE_INVOICE_FIXATION` – Criar notas fiscais na fixação * `CANCEL_INVOICE_FIXATION` – Cancela notas fiscais na fixação * `CLOSE_INVOICE_FIXATION` – Fecha notas fiscais na fixação * `PRESCRIPTION_DATA_LOAD` – Carga de dados de receita agronômica * `CLOSE_INVOICE_TRANSFER` – Fecha notas fiscais no receituário * `REOPEN_INVOICE_TRANSFER` – Reabertura da nota fiscal de transferencia via cancelamento * `TRANSFER_CREATE_FINANCIAL_TITLE` – Cria titulo financeiro transferência * `TRANSFER_CANCEL_FINANCIAL_TITLE` – Cancela titulo financeiro transferência * `TRANSFER_CREATE_SERVICE_INVOICE` – Cria nota fiscal de serviço para transferência * `TRANSFER_CANCEL_SERVICE_INVOICE` – Cancela nota fiscal de serviço para transferência * `REOPEN_INVOICE_FIXATION` – Reabre nota fechada na fixação eventStatus: type: string enum: – PENDING – PROCESSING – SUCCESS – FAILED – CANCELED description: Status do evento: * `PENDING` – Pendente * `PROCESSING` – Processado * `SUCCESS` – Sucesso * `FAILED` – Falha * `CANCELED` – Cancelado 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 checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck eventControlReceived: description: Record de controle de eventos recebidos type: object required: – e070emp – e070fil – eventOrigin – externalId – status properties: e070emp: type: string description: Empresa e070fil: type: string description: Filial eventOrigin: type: string allOf: – #/definitions/eventOrigin description: Origem do evento externalId: type: string description: Id externo status: type: string allOf: – #/definitions/eventStatus description: Status do evento controlCode: type: string description: Codigo de controle da origem do evento eventControlItemReceived: description: Record de items de eventos recebidos type: object required: – eventGroup – sequence – eventOperation properties: eventGroup: type: string description: Grupo do evento sequence: type: integer format: int64 description: Sequência do evento eventOperation: type: string allOf: – #/definitions/eventOperation description: Tipo da operação do evento input: type: string description: Input do evento enviado no payload da primitiva output: type: string description: Output do evento recebido no payload da primitiva message: type: string description: Mensagem de evento signalEffectiveInput: description: Payload do saldo efetivado type: object required: – producerInvoiceId – eventControlItemId properties: producerInvoiceId: type: string description: Id do registro de producerInvoice na originação do evento eventControlItemId: type: string description: Id do registro de item de evento signalEffectiveConfirmationInput: description: Payload para confirmação do saldo efetivado pela nota fiscal type: object required: – producerInvoiceId – eventControlItemId properties: producerInvoiceId: type: string description: Id do registro de producerInvoice na originação do evento eventControlItemId: type: string description: Id do registro de item de evento controlCodeList: description: Retorno do lookup de controlCode type: object required: – controlCode properties: controlCode: type: integer format: int64 description: Número identificador do evento e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia / Sigla da empresa extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e070fil: description: Filial type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFil: type: integer format: int64 description: Código da filial nomFil: type: string maxLength: 100 description: Nome da filial sigFil: type: string maxLength: 100 description: Nome fantasia da filial numCgc: type: string maxLength: 18 description: CNPJ cidFil: type: string maxLength: 60 description: Cidade numFon: type: string maxLength: 20 description: Numero Telefone extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: eventControl: description: Controle de eventos type: object required: – e070emp – e070fil – eventOrigin – externalId properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial eventOrigin: type: string allOf: – #/definitions/eventOrigin description: Origem do evento externalId: type: string format: uuid description: Id externo controlCode: type: integer format: int64 description: Código de controle da origem do evento eventControlItem: type: array items: type: object allOf: – #/definitions/eventControlItem description: Lista de eventos do controle createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEventControl: type: object required: – id allOf: – #/definitions/eventControl eventControlItem: description: Itens do controle de eventos type: object required: – eventDomain – eventService – eventPrimitive – eventGroup – sequence – eventOperation – status properties: id: type: string format: uuid description: Id da entidade eventDomain: type: string description: Dominio que irá receber o evento eventService: type: string description: Serviço que irá receber o evento eventPrimitive: type: string description: Primitiva que irá receber o evento eventControl: type: object allOf: – #/definitions/eventControl description: eventControlId eventGroup: type: string format: uuid description: Grupo do evento sequence: type: integer format: int64 description: Sequência do evento eventOperation: type: string allOf: – #/definitions/eventOperation description: Tipo da operação do evento input: type: string description: Input do evento enviado no payload da primitiva output: type: string description: Output do evento recebido no payload da primitiva status: type: string allOf: – #/definitions/eventStatus description: Status do evento message: type: string description: Mensagem de evento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEventControlItem: type: object required: – id allOf: – #/definitions/eventControlItem 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 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