2.0info: 2.0.0 Data Lake description: Serviço responsável pelo Datalake do Agro. x-senior-domain: Agro x-senior-domain-path: agro x-senior-service-path: datalake 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: /datalake/queries/healthcheck: post: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviços checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake/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 /datalake/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 /datalake/actions/createDatasets: post: description: Cria os datasets de fábrica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – datasets properties: datasets: type: array items: type: string allOf: – #/definitions/enumDatasetType minimum: 1 description: Tipos de datasets que serão criados responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: true or false para o sucesso do processo de criação dos datasets informados 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 enumDatasetType: type: string enum: – AGRO_VARIABLE_COST_OFFENDERS_ID – AGRO_PRODUCTION_COST_BY_PLACE_FIXED_ID – AGRO_PRODUCTION_COST_BY_PLACE_VARIABLE_ID – AGRO_PRODUCTION_COST_BY_PLACE_TOTAL_ID – AGRO_COMPARATIVE_COST_BY_HARVEST_CULTURE_ID – AGRO_EVOLUTION_COST_BY_HARVEST_ID – AGRO_COMPARATIVE_COST_BY_ITEM_ID – AGRO_LIST_CULTURE_ID – AGRO_LIST_DESCRIPTION_ID – AGRO_LIST_HARVEST_ID – AGRO_LIST_CITY_ID – AGRO_LIST_STATE_ID – AGRO_LIST_PERIOD_ID – AGRO_LIST_YEAR_ID – AGRO_COMPARATIVE_COST_BY_CITY_ID description: Lista de tipo de Dataset do Datalake do Agro.: * `AGRO_VARIABLE_COST_OFFENDERS_ID` – Dataset para a extração dos maiores ofensores de custo variável * `AGRO_PRODUCTION_COST_BY_PLACE_FIXED_ID` – Dataset de extração dos custos fixos de produção por estado/cidade * `AGRO_PRODUCTION_COST_BY_PLACE_VARIABLE_ID` – Dataset de extração dos custos variáveis de produção por estado/cidade * `AGRO_PRODUCTION_COST_BY_PLACE_TOTAL_ID` – Dataset de extração dos custos totais de produção por estado/cidade * `AGRO_COMPARATIVE_COST_BY_HARVEST_CULTURE_ID` – Dataset para a extração do comparativo de custos por safra/cultura * `AGRO_EVOLUTION_COST_BY_HARVEST_ID` – Dataset para a extração da evolução dos custos por safra * `AGRO_COMPARATIVE_COST_BY_ITEM_ID` – Dataset para a extração do comparativo de custos por item * `AGRO_LIST_CULTURE_ID` – Lista completa das culturas * `AGRO_LIST_DESCRIPTION_ID` – Lista completa das descrições de custos * `AGRO_LIST_HARVEST_ID` – Lista completa dos nomes das safras * `AGRO_LIST_CITY_ID` – Lista completa de cidades na base CONAB * `AGRO_LIST_STATE_ID` – Lista completa de estados na base CONAB * `AGRO_LIST_PERIOD_ID` – Lista completa de períodos na base CONAB * `AGRO_LIST_YEAR_ID` – Lista completa de anos na base CONAB * `AGRO_COMPARATIVE_COST_BY_CITY_ID` – Dataset para a extração do comparativo dos custos por cidade 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 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 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. 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