2.0info: 3.2.0 Custo de Produção description: Serviço responsável pelo CMS do Agro Datalake. x-senior-domain: Agronegócio x-senior-domain-path: agro x-senior-service-path: datalake_cms 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_cms/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_cms/queries/listCulture: post: description: Query para recuperar a lista de culturas do datalake – view variável – utilizado no filtro da página 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 orderby: type: string description: ordenação default: description asc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Query para recuperar a lista de culturas do datalake – view variável – utilizado no filtro da página 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 – name: orderby description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista das culturas possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/getProductionCostByHarvest: post: description: Dataset de API para o analytics de comparação dos custos por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado factors: type: array items: type: boolean description: Total de fatores responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/dataProjectionAnalytics minimum: 1 description: Retorno padrão para analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/getEvolutionCostByHarvest: post: description: Dataset de API para o analytics de evolução (delta) dos custos por safra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado factors: type: array items: type: boolean description: Total de fatores responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/dataProjectionAnalytics minimum: 1 description: Retorno padrão para analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/getProductionCostByCity: post: description: Dataset de API para os analytics de custo de produção por cidade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado factors: type: array items: type: boolean description: Total de fatores responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/dataProjectionProductionCost minimum: 1 description: Retorno padrão para analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/getComparativeCostByState: post: description: Dataset de API para os analytics de comparação dos custos de produção por estado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado factors: type: array items: type: boolean description: Total de fatores responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/dataProjectionAnalytics minimum: 1 description: Retorno padrão para analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/getTopFiveOffenders: post: description: Dataset de API para os analytics de exibição dos 5 maiores ofensores de custo variável tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado responses: 200: description: Ok schema: type: object required: – projectionAnalytics properties: projectionAnalytics: type: array items: type: object allOf: – #/definitions/dataProjectionAnalytics minimum: 1 description: Retorno padrão para analytics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/listHarvest: post: description: Query para recuperar a lista de safras do datalake – view variável – utilizado no filtro da página 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 orderby: type: string description: ordenação default: description asc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista das safras possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Query para recuperar a lista de safras do datalake – view variável – utilizado no filtro da página 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 – name: orderby description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista das safras possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/listYear: post: description: Query para recuperar a lista de anos do datalake – utilizado no filtro da página 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 orderby: type: string description: ordenação default: description asc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista dos anos possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Query para recuperar a lista de anos do datalake – utilizado no filtro da página 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 – name: orderby description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista dos anos possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/listMonth: post: description: Query para recuperar a lista de meses do datalake – utilizado no filtro da página 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 orderby: type: string description: ordenação default: description asc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista dos meses possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Query para recuperar a lista de meses do datalake – utilizado no filtro da página 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 – name: orderby description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista dos meses possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/listCity: post: description: Query para recuperar a lista de cidades do datalake – utilizado no filtro da página 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 state: type: array items: type: string description: estado para filtrar as cidades page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 orderby: type: string description: ordenação default: description asc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista dos cidades possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/listState: post: description: Query para recuperar a lista de estados do datalake – utilizado no filtro da página 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 orderby: type: string description: ordenação default: description asc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista dos estados(UF) possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Query para recuperar a lista de estados do datalake – utilizado no filtro da página 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 – name: orderby description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/dataGeneralDataset description: Lista dos estados(UF) possíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/comparisonEvolutionCostByHarvest: post: description: Dataset de API para comparação dos custos de produção pegando a evolução dos custos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado factors: type: array items: type: boolean description: Total de fatores responses: 200: description: Ok schema: type: object required: – projectionAnalyticsComparison properties: projectionAnalyticsComparison: type: array items: type: object allOf: – #/definitions/dataProjectionAnalyticsComparison minimum: 1 description: Retorno padrão para analytics de comparação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/comparisonProductionCostByHarvest: post: description: Dataset de API para comparação dos custos de produção pegando os custos de produção tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado factors: type: array items: type: boolean description: Total de fatores responses: 200: description: Ok schema: type: object required: – projectionAnalyticsComparison properties: projectionAnalyticsComparison: type: array items: type: object allOf: – #/definitions/dataProjectionAnalyticsComparison minimum: 1 description: Retorno padrão para analytics de comparação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/queries/comparisonProductionCostByCity: post: description: Dataset de API para comparação dos custos de produção pegando os custos de produção por cidade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: costType: type: array items: type: string allOf: – #/definitions/costType description: Filtro de tipo de custo culture: type: array items: type: string description: Cultura description: type: array items: type: string description: Descrição harvest: type: array items: type: string description: Safra year: type: array items: type: string description: Ano month: type: array items: type: string description: Mês city: type: array items: type: string description: Cidade state: type: array items: type: string description: Estado factors: type: array items: type: boolean description: Total de fatores responses: 200: description: Ok schema: type: object required: – projectionAnalyticsComparison properties: projectionAnalyticsComparison: type: array items: type: object allOf: – #/definitions/dataProjectionAnalyticsComparison minimum: 1 description: Retorno padrão para analytics de comparação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/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_cms/queries/exportProductionCost: 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 /datalake_cms/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_cms/actions/clearStructures: post: description: Remove todas as estruturas de dados, menos os tipos explicitamente marcados como false tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: analytics: type: boolean description: Remover analytics default: true page: type: boolean description: Remover páginas default: true landingpage: type: boolean description: Remover landing pages default: true responses: 200: description: Ok schema: type: object required: – analyticsCount – pageCount – landingpageCount properties: analyticsCount: type: integer format: int64 description: Analytics removidos pageCount: type: integer format: int64 description: Páginas removidas landingpageCount: type: integer format: int64 description: Landing pages removidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/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/genericError /datalake_cms/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/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 /datalake_cms/actions/importProductionCost: 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 /datalake_cms/signals/recreateStructures: post: description: Recria todas as estruturas de dados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenant properties: removeBefore: type: boolean description: Remover estruturas antes default: true recreateShared: type: boolean description: Remover estruturas antes default: true recreateAnonymous: type: boolean description: Remover estruturas antes default: true tenant: type: string description: Tenant para recriar a esrutura filter: type: array items: type: string description: Filtra quais datasets criar responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /datalake_cms/events/importProductionCostEvent: 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 /datalake_cms/events/exportProductionCostEvent: 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 /datalake_cms/entities/productionCost: 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/productionCost responses: 200: description: The created resource schema: #/definitions/productionCost 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/productionCost responses: 200: description: The created resource schema: #/definitions/productionCost 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/productionCost 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datalake_cms/entities/productionCost/{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/editProductionCost responses: 200: description: Ok schema: #/definitions/editProductionCost 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/productionCost responses: 200: description: Ok schema: #/definitions/productionCost 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/productionCost 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 /datalake_cms/entities/productionCost/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/productionCost 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 costType: type: string enum: – FIX_COST – TOTAL_COST – VARIABLE_COST description: Tipos de custo: * `FIX_COST` – Custo Fixo * `TOTAL_COST` – Custo Total * `VARIABLE_COST` – Custo Variável enumCacheDataset: type: string enum: – LIST_CITIES – LIST_STATES – LIST_DESCRIPTIONS – LIST_CULTURES – LIST_HARVESTS – LIST_YEARS description: valores dos caches de dataset: * `LIST_CITIES` – Cache da lista de cidades * `LIST_STATES` – Cache da lista de estados * `LIST_DESCRIPTIONS` – Cache da lista de tipos de custo * `LIST_CULTURES` – Cache da lista de culturas * `LIST_HARVESTS` – Cache da lista de safras * `LIST_YEARS` – Cache da lista de anos 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 dataGeneralDataset: description: Lista de datasets type: object required: – id – description properties: id: type: string description: Id dataset description: type: string description: Descrição filter: type: string description: Filter dataProjectionAnalytics: description: Retorno dos datasets de API, padrão para o analytics type: object required: – column – series properties: column: type: string description: valores da coluna series: type: number format: double description: valores da série dataProjectionAnalyticsComparison: description: Retorno dos dataset de API de comparação dos custos de produção type: object required: – column – seriesClient – seriesConab properties: column: type: string description: valores da coluna seriesClient: type: number format: double description: valores da série do cliente seriesConab: type: number format: double description: valores da série da conab datalake dataProjectionProductionCost: description: Retorno do analytics de custos de produção por cidade, pois esse tem particularidades na exibição type: object required: – stateCity – latitude – longitude – cost – businessUnit properties: stateCity: type: string description: Cidade latitude: type: number format: double description: latitude longitude: type: number format: double description: longitude cost: type: number format: double description: custo businessUnit: type: number format: double description: unidade de medida productionCost: description: Produção de custo type: object required: – cost – season – year – costDescription – culture – state – city properties: id: type: string format: uuid description: Id cost: type: number format: double description: Custo season: type: string description: Safra month: type: string description: Mês year: type: integer format: int64 description: Ano costDescription: type: string allOf: – #/definitions/costType description: Descrição do custo culture: type: string description: Cultura state: type: string description: Estado city: type: string description: Cidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editProductionCost: type: object required: – id allOf: – #/definitions/productionCost 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