2.0info: 2.0.0 Análise de oferta e demanda description: Análise de oferta e demanda x-senior-domain: AGRO x-senior-domain-path: agro x-senior-service-path: supply_demand 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: /supply_demand/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 /supply_demand/queries/listCultures: post: description: Retorna as culturas disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as culturas disponíveis para seleção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/listInitialPeriod: post: description: Retorna os anos de período inicial disponíveis para seleção conforme a cultura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – culture properties: culture: type: string description: cultura searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os anos de período inicial disponíveis para seleção conforme a cultura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: culture description: cultura in: query required: true type: string – name: searchTerm description: valor a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/listFinalPeriod: post: description: Retorna os anos de período final disponíveis para seleção conforme a cultura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – culture properties: culture: type: string description: cultura searchTerm: type: string description: valor a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os anos de período final disponíveis para seleção conforme a cultura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: culture description: cultura in: query required: true type: string – name: searchTerm description: valor a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/tendencyLineSupplyByHarvest: post: description: Query para consultar as informações de oferta e demanda e a tendência de oferta por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: culture: type: array items: type: string description: Cultura initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/tendencyLineByHarvestProjection minimum: 1 description: Retorno padrão analytics de linha de tendência de oferta por safra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/tendencyLineDemandByHarvest: post: description: Query para consultar as informações de oferta e demanda e a tendência de demanda por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: culture: type: array items: type: string description: Cultura initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/tendencyLineByHarvestProjection minimum: 1 description: Retorno padrão analytics de linha de tendência de demanda por safra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/supplyDemandByHarvest: post: description: Query para consultar as informações de oferta e demanda por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: culture: type: array items: type: string description: Cultura initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/supplyDemandByHarvestProjection minimum: 1 description: Retorno padrão analytics do gráfico de oferta e demanda por safra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/offerTypePercentageByHarvest: post: description: Query para consultar o percentual de tipos de oferta por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: culture: type: array items: type: string description: Cultura initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/offerTypePercentageByHarvestProjection minimum: 1 description: Retorno padrão analytics do gráfico de tipos de oferta por safra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/demandTypePercentageByHarvest: post: description: Query para consultar o percentual de tipos de demanda por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: culture: type: array items: type: string description: Cultura initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/demandTypePercentageByHarvestProjection minimum: 1 description: Retorno padrão analytics do gráfico de tipos de oferta por safra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/queries/supplyDemandGeneralByHarvest: post: description: Query para consultar as informações gerais de oferta e demanda por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: culture: type: array items: type: string description: Cultura initialPeriod: type: array items: type: string description: Período inicial finalPeriod: type: array items: type: string description: Período final responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/supplyDemandGeneralByHarvestProjection minimum: 1 description: Retorno padrão analytics do gráfico de oferta e demanda por safra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /supply_demand/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 /supply_demand/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 /supply_demand/actions/clearDatasetCache: post: description: Limpa o cache de um Dataset tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: datasets: type: array items: type: string allOf: – #/definitions/enumCacheDataset description: Dataset que serão limpos os caches responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Referente ao sucesso da operação 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 enumCacheDataset: type: string enum: – LIST_CULTURES – LIST_INITIAL_PERIOD – LIST_FINAL_PERIOD description: valores dos caches de dataset: * `LIST_CULTURES` – Cache da lista de culturas * `LIST_INITIAL_PERIOD` – Cache da lista de período inicial * `LIST_FINAL_PERIOD` – Cache da lista de período final 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 tendencyLineByHarvestProjection: description: Retorno padrão analytics de linha de tendência de oferta/demanda por safra type: object required: – period – supplyDemand – tendency properties: period: type: string description: Período da safra supplyDemand: type: number format: double description: Oferta/Demanda tendency: type: number format: double description: Tendência supplyDemandByHarvestProjection: description: Retorno padrão analytics do gráfico de oferta e demanda por safra type: object required: – period – supply – demand properties: period: type: string description: Período da safra supply: type: number format: double description: Oferta demand: type: number format: double description: Demanda offerTypePercentageByHarvestProjection: description: Retorno padrão analytics do gráfico de tipos de oferta por safra type: object required: – period – inventory – imported – production properties: period: type: string description: Período da safra inventory: type: number format: double description: Estoque Inicial imported: type: number format: double description: Importação production: type: number format: double description: Production demandTypePercentageByHarvestProjection: description: Retorno padrão analytics do gráfico de tipos de demanda por safra type: object required: – period – exported – consumption properties: period: type: string description: Período da safra exported: type: number format: double description: Estoque Inicial consumption: type: number format: double description: Importação defaultDataLookup: description: Retorno padrão para lookup de dados type: object required: – id – description properties: id: type: string description: Id description: type: string description: Descrição supplyDemandGeneralByHarvestProjection: description: Retorno padrão analytics do gráfico geral de oferta e demanda por safra type: object required: – period – inventory – production – imported – exported – consumption properties: period: type: string description: Período da safra inventory: type: number format: double description: Estoque Inicial production: type: number format: double description: Produção imported: type: number format: double description: Importação exported: type: number format: double description: Exportação consumption: type: number format: double description: Consumo 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