api/swagger-spec.json
{"openapi":"3.0.0","paths":{"/health":{"get":{"operationId":"HealthController_check","parameters":[],"responses":{"200":{"description":"The Health Check is successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"ok"},"info":{"type":"object","example":{"database":{"status":"up"}},"additionalProperties":{"type":"object","properties":{"status":{"type":"string"}},"additionalProperties":{"type":"string"}},"nullable":true},"error":{"type":"object","example":{},"additionalProperties":{"type":"object","properties":{"status":{"type":"string"}},"additionalProperties":{"type":"string"}},"nullable":true},"details":{"type":"object","example":{"database":{"status":"up"}},"additionalProperties":{"type":"object","properties":{"status":{"type":"string"}},"additionalProperties":{"type":"string"}}}}}}}},"503":{"description":"The Health Check is not successful","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"error"},"info":{"type":"object","example":{"database":{"status":"up"}},"additionalProperties":{"type":"object","properties":{"status":{"type":"string"}},"additionalProperties":{"type":"string"}},"nullable":true},"error":{"type":"object","example":{"redis":{"status":"down","message":"Could not connect"}},"additionalProperties":{"type":"object","properties":{"status":{"type":"string"}},"additionalProperties":{"type":"string"}},"nullable":true},"details":{"type":"object","example":{"database":{"status":"up"},"redis":{"status":"down","message":"Could not connect"}},"additionalProperties":{"type":"object","properties":{"status":{"type":"string"}},"additionalProperties":{"type":"string"}}}}}}}}}}},"/api/v1/admin-regions":{"get":{"operationId":"AdminRegionsController_findAll","summary":"","description":"Find all admin regions","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`, `description`, `status`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRegion"}}}},"401":{"description":""},"403":{"description":""}},"tags":["AdminRegion"],"security":[{"bearer":[]}]},"post":{"operationId":"AdminRegionsController_create","summary":"","description":"Create a admin region","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAdminRegionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRegion"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["AdminRegion"],"security":[{"bearer":[]}]}},"/api/v1/admin-regions/trees":{"get":{"operationId":"AdminRegionsController_getTrees","summary":"","description":"Find all admin regions and return them in a tree format. Data in the \"children\" will recursively extend for the full depth of the tree","parameters":[{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioIds","required":false,"in":"query","description":"Array of Scenario Ids to include entities present in them","schema":{"type":"array","items":{"type":"string"}}},{"name":"withSourcingLocations","required":false,"in":"query","description":"Return Admin Regions with related Sourcing Locations. Setting this to true will override depth param","schema":{"type":"boolean"}},{"name":"depth","required":false,"in":"query","schema":{"type":"number"}},{"name":"scenarioId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AdminRegion"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/AdminRegion"}}}}]}}}},"401":{"description":""},"403":{"description":""}},"tags":["AdminRegion"],"security":[{"bearer":[]}]}},"/api/v1/admin-regions/{countryId}/regions":{"get":{"operationId":"AdminRegionsController_findRegionsByCountry","summary":"","description":"Find all admin regions given a country and return data in a tree format. Data in the \"children\" will recursively extend for the full depth of the tree","parameters":[{"name":"countryId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AdminRegion"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/AdminRegion"}}}}]}}}},"401":{"description":""},"404":{"description":"Admin region not found"}},"tags":["AdminRegion"],"security":[{"bearer":[]}]}},"/api/v1/admin-regions/{id}":{"get":{"operationId":"AdminRegionsController_findOne","summary":"","description":"Find admin region by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRegion"}}}},"404":{"description":"Admin region not found"}},"tags":["AdminRegion"],"security":[{"bearer":[]}]},"patch":{"operationId":"AdminRegionsController_update","summary":"","description":"Updates a admin region","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdminRegionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRegion"}}}},"404":{"description":"Admin region not found"}},"tags":["AdminRegion"],"security":[{"bearer":[]}]},"delete":{"operationId":"AdminRegionsController_delete","summary":"","description":"Deletes a admin region","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Admin region not found"}},"tags":["AdminRegion"],"security":[{"bearer":[]}]}},"/api/v1/materials":{"get":{"operationId":"MaterialsController_findAll","summary":"","description":"Find all materials and return them in a list format","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned. Allowed values are: `children`.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`, `description`, `status`, `hsCodeId`, `earthstatId`, `mapspamId`, `metadata`, `h3Grid`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Material"}}}},"401":{"description":""},"403":{"description":""}},"tags":["Material"],"security":[{"bearer":[]}]},"post":{"operationId":"MaterialsController_create","summary":"","description":"Create a material","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMaterialDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Material"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["Material"],"security":[{"bearer":[]}]}},"/api/v1/materials/trees":{"get":{"operationId":"MaterialsController_getTrees","summary":"","description":"Find all materials and return them in a tree format. Data in the \"children\" will recursively extend for the full depth of the tree","parameters":[{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioIds","required":false,"in":"query","description":"Array of Scenario Ids to include entities present in them","schema":{"type":"array","items":{"type":"string"}}},{"name":"withSourcingLocations","required":false,"in":"query","description":"Return Materials with related Sourcing Locations. Setting this to true will override depth param","schema":{"type":"boolean"}},{"name":"depth","required":false,"in":"query","schema":{"type":"number"}},{"name":"scenarioId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Material"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/Material"}}}}]}}}},"401":{"description":""},"403":{"description":""}},"tags":["Material"],"security":[{"bearer":[]}]}},"/api/v1/materials/{id}":{"get":{"operationId":"MaterialsController_findOne","summary":"","description":"Find material by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Material"}}}},"404":{"description":"Material not found"}},"tags":["Material"],"security":[{"bearer":[]}]},"patch":{"operationId":"MaterialsController_update","summary":"","description":"Updates a material","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMaterialDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Material"}}}},"404":{"description":"Material not found"}},"tags":["Material"],"security":[{"bearer":[]}]},"delete":{"operationId":"MaterialsController_delete","summary":"","description":"Deletes a material","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Material not found"}},"tags":["Material"],"security":[{"bearer":[]}]}},"/api/v1/suppliers":{"get":{"operationId":"SuppliersController_findAll","summary":"","description":"Find all suppliers","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`, `description`, `status`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"401":{"description":""},"403":{"description":""}},"tags":["Supplier"],"security":[{"bearer":[]}]},"post":{"operationId":"SuppliersController_create","summary":"","description":"Create a supplier","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSupplierDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["Supplier"],"security":[{"bearer":[]}]}},"/api/v1/suppliers/trees":{"get":{"operationId":"SuppliersController_getTrees","summary":"","description":"Find all suppliers and return them in a tree format. Data in the \"children\" will recursively extend for the full depth of the tree","parameters":[{"name":"withSourcingLocations","required":false,"in":"query","description":"Return Suppliers with related Sourcing Locations. Setting this to true will override depth param","schema":{"type":"boolean"}},{"name":"depth","required":false,"in":"query","schema":{"type":"number"}},{"name":"materialIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"supplierIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioId","required":false,"in":"query","description":"Array of Scenario Ids to include in the supplier search","schema":{"type":"string"}},{"name":"scenarioIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}}}}]}}}},"401":{"description":""},"403":{"description":""}},"tags":["Supplier"],"security":[{"bearer":[]}]}},"/api/v1/suppliers/types":{"get":{"operationId":"SuppliersController_getSupplierByType","summary":"","description":"Find all suppliers by type","parameters":[{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioIds","required":false,"in":"query","description":"Array of Scenario Ids to include entities present in them","schema":{"type":"array","items":{"type":"string"}}},{"name":"type","required":true,"in":"query","schema":{"enum":["t1supplier","producer"],"type":"string"}},{"name":"sort","required":true,"in":"query","description":"The sort order by Name for the resulting entities. Can be 'ASC' (Ascendant) or 'DESC' (Descendent). Defaults to ASC","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"401":{"description":""},"403":{"description":""}},"tags":["Supplier"],"security":[{"bearer":[]}]}},"/api/v1/suppliers/{id}":{"get":{"operationId":"SuppliersController_findOne","summary":"","description":"Find supplier by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"404":{"description":"Supplier not found"}},"tags":["Supplier"],"security":[{"bearer":[]}]},"patch":{"operationId":"SuppliersController_update","summary":"","description":"Updates a supplier","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupplierDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Supplier"}}}},"404":{"description":"Supplier not found"}},"tags":["Supplier"],"security":[{"bearer":[]}]},"delete":{"operationId":"SuppliersController_delete","summary":"","description":"Deletes a supplier","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Supplier not found"}},"tags":["Supplier"],"security":[{"bearer":[]}]}},"/api/v1/business-units":{"get":{"operationId":"BusinessUnitsController_findAll","summary":"","description":"Find all business units","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`, `description`, `status`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUnit"}}}},"401":{"description":""},"403":{"description":""}},"tags":["BusinessUnit"],"security":[{"bearer":[]}]},"post":{"operationId":"BusinessUnitsController_create","summary":"","description":"Create a business unit","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBusinessUnitDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUnit"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["BusinessUnit"],"security":[{"bearer":[]}]}},"/api/v1/business-units/trees":{"get":{"operationId":"BusinessUnitsController_getTrees","summary":"","description":"Find all business units with sourcing-locations and return them in a tree format.","parameters":[{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioIds","required":false,"in":"query","description":"Array of Scenario Ids to include entities present in them","schema":{"type":"array","items":{"type":"string"}}},{"name":"withSourcingLocations","required":false,"in":"query","description":"Return Business Units with related Sourcing Locations. Setting this to true will override depth param","schema":{"type":"boolean"}},{"name":"depth","required":false,"in":"query","schema":{"type":"number"}},{"name":"scenarioId","required":false,"in":"query","description":"Array of Scenario Ids to include in the business unit search","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BusinessUnit"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/BusinessUnit"}}}}]}}}},"401":{"description":""},"403":{"description":""}},"tags":["BusinessUnit"],"security":[{"bearer":[]}]}},"/api/v1/business-units/{id}":{"get":{"operationId":"BusinessUnitsController_findOne","summary":"","description":"Find business unit by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUnit"}}}},"404":{"description":"Business unit not found"}},"tags":["BusinessUnit"],"security":[{"bearer":[]}]},"patch":{"operationId":"BusinessUnitsController_update","summary":"","description":"Updates a business unit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBusinessUnitDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUnit"}}}},"404":{"description":"Business unit not found"}},"tags":["BusinessUnit"],"security":[{"bearer":[]}]},"delete":{"operationId":"BusinessUnitsController_delete","summary":"","description":"Deletes a business unit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Business unit not found"}},"tags":["BusinessUnit"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-locations":{"get":{"operationId":"SourcingLocationsController_findAll","summary":"","description":"Find all sourcing locations","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned. Allowed values are: `sourcingLocationGroup`.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `title`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocation"}}}},"401":{"description":""},"403":{"description":""}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]},"post":{"operationId":"SourcingLocationsController_create","summary":"","description":"Create a sourcing location","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSourcingLocationDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocation"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-locations/materials":{"get":{"operationId":"SourcingLocationsController_findAllMaterials","summary":"","description":"Find all Materials with details for Sourcing Locations","parameters":[{"name":"orderBy","required":false,"in":"query","schema":{"enum":["country","businessUnit","producer","t1Supplier","material","locationType"],"type":"string"}},{"name":"order","required":false,"in":"query","schema":{"enum":["desc","asc"],"type":"string"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocationsMaterialsResponseDto"}}}},"401":{"description":""},"403":{"description":""}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-locations/location-types":{"get":{"operationId":"SourcingLocationsController_getLocationTypes","summary":"","description":"Gets available location types. Optionally returns all supported location types","parameters":[{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioIds","required":false,"in":"query","description":"Array of Scenario Ids to include entities present in them","schema":{"type":"array","items":{"type":"string"}}},{"name":"scenarioId","required":false,"in":"query","schema":{"type":"string"}},{"name":"supported","required":false,"in":"query","description":"Get all supported location types. Setting this to true overrides all other parameters","schema":{"type":"boolean"}},{"name":"sort","required":false,"in":"query","description":"Sorting parameter to order the result. Defaults to ASC ","schema":{"enum":["ASC","DESC"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationTypesDto"}}}}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-locations/location-types/supported":{"get":{"operationId":"SourcingLocationsController_getAllSupportedLocationTypes","summary":"","description":"Get location types supported by the platform","deprecated":true,"parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationTypesDto"}}}}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-locations/{id}":{"get":{"operationId":"SourcingLocationsController_findOne","summary":"","description":"Find sourcing location by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocation"}}}},"404":{"description":"Sourcing location not found"}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]},"patch":{"operationId":"SourcingLocationsController_update","summary":"","description":"Updates a sourcing location","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSourcingLocationDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocation"}}}},"404":{"description":"Sourcing location not found"}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]},"delete":{"operationId":"SourcingLocationsController_delete","summary":"","description":"Deletes a sourcing location","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Sourcing location not found"}},"tags":["SourcingLocation"],"security":[{"bearer":[]}]}},"/auth/sign-in":{"post":{"operationId":"sign-in","summary":"Sign user in","description":"Sign user in, issuing a JWT token.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginDto"}}}},"responses":{"201":{"description":"Login successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}}},"tags":["Authentication"],"security":[{"bearer":[]}]}},"/auth/validate-account":{"post":{"operationId":"AuthenticationController_validateAccount","summary":"","description":"Confirm an activation for a new user.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSONAPIUserData"}}}}},"tags":["Authentication"],"security":[{"bearer":[]}]}},"/auth/validate-token":{"get":{"operationId":"AuthenticationController_validateToken","parameters":[],"responses":{"200":{"description":""}},"tags":["Authentication"],"security":[{"bearer":[]}]}},"/auth/refresh-token":{"post":{"operationId":"refresh-token","summary":"Refresh JWT token","description":"Request a fresh JWT token, given a still-valid one for the same user; no request payload is required: the user id is read from the JWT token presented.","parameters":[],"responses":{"201":{"description":"Token refreshed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessToken"}}}},"401":{"description":""}},"tags":["Authentication"],"security":[{"bearer":[]}]}},"/api/v1/api-events":{"get":{"operationId":"ApiEventsController_findAll","summary":"","description":"Find all API events","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEventResult"}}}},"401":{"description":""},"403":{"description":""}},"tags":["ApiEvents"]},"post":{"operationId":"ApiEventsController_create","summary":"","description":"Create an API event","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiEventDTO"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEvent"}}}}},"tags":["ApiEvents"]}},"/api/v1/api-events/kind/{kind}/topic/{topic}/latest":{"get":{"operationId":"ApiEventsController_findLatestEventByKindAndTopic","summary":"","description":"Find latest API event by kind for a given topic","parameters":[{"name":"kind","required":true,"in":"path","schema":{"type":"string"}},{"name":"topic","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEvent"}}}}},"tags":["ApiEvents"]}},"/api/v1/api-events/kind/{kind}/topic/{topic}":{"delete":{"operationId":"ApiEventsController_deleteEventSeriesByKindAndTopic","summary":"","description":"Delete API event series by kind for a given topic","parameters":[{"name":"kind","required":true,"in":"path","schema":{"type":"string"}},{"name":"topic","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEvent"}}}}},"tags":["ApiEvents"]}},"/api/v1/users":{"get":{"operationId":"UsersController_findAll","summary":"","description":"Find all users","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned. Allowed values are: `projects`.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"401":{"description":"Unauthorized."},"403":{"description":"The current user does not have suitable permissions for this request."}},"tags":["User"],"security":[{"bearer":[]}]},"post":{"operationId":"UsersController_createUser","summary":"","description":"Create new user","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserDTO"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"201":{"description":"User created successfully"}},"tags":["User"],"security":[{"bearer":[]}]}},"/api/v1/users/me/password":{"patch":{"operationId":"UsersController_updateOwnPassword","summary":"","description":"Update the password of a user, if they can present the current one.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPasswordDTO"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResult"}}}}},"tags":["User"],"security":[{"bearer":[]}]}},"/api/v1/users/me":{"patch":{"operationId":"UsersController_update","summary":"","description":"Update own user.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOwnUserDTO"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResult"}}}}},"tags":["User"],"security":[{"bearer":[]}]},"get":{"operationId":"UsersController_userMetadata","summary":"","description":"Retrieve attributes of the current user","parameters":[],"responses":{"401":{"description":"Unauthorized."},"403":{"description":"The current user does not have suitable permissions for this request."},"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResult"}}}}},"tags":["User"],"security":[{"bearer":[]}]},"delete":{"operationId":"UsersController_deleteOwnUser","summary":"","description":"Mark user as deleted.","parameters":[],"responses":{"200":{"description":""},"401":{"description":""},"403":{"description":""}},"tags":["User"],"security":[{"bearer":[]}]}},"/api/v1/users/me/password/recover":{"post":{"operationId":"UsersController_recoverPassword","summary":"","description":"Recover password presenting a valid user email","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecoverPasswordDto"}}}},"responses":{"200":{"description":""}},"tags":["User"],"security":[{"bearer":[]}]}},"/api/v1/users/me/password/reset":{"post":{"operationId":"UsersController_resetPassword","summary":"","description":"Reset a user password presenting a valid token","parameters":[{"name":"authorization","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordDto"}}}},"responses":{"200":{"description":""}},"tags":["User"],"security":[{"bearer":[]}]}},"/api/v1/users/{id}":{"patch":{"operationId":"UsersController_updateUser","summary":"","description":"Update a user as admin","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDTO"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"201":{"description":"User created successfully"},"403":{"description":""}},"tags":["User"],"security":[{"bearer":[]}]}},"/api/v1/users/{userId}":{"delete":{"operationId":"UsersController_deleteUser","summary":"","description":"Delete a user. This operation will destroy any resource related to the user and it will be irreversible","parameters":[{"name":"userId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"401":{"description":""},"403":{"description":""}},"tags":["User"],"security":[{"bearer":[]}]}},"/api/v1/scenarios":{"get":{"operationId":"ScenariosController_findAll","summary":"","description":"Find all scenarios","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `title`, `description`, `status`, `userId`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}},{"name":"search","required":true,"in":"query","description":"Must be provided when searching with partial matching. Each key of the map corresponds to a field that is to be matched partially, and its value, the string that will be partially matched against","schema":{"type":"map<string, string>"}},{"name":"hasActiveInterventions","required":false,"in":"query","description":"If true, only scenarios with at least one active intervention will be selected.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}}},"401":{"description":""},"403":{"description":""}},"tags":["Scenario"],"security":[{"bearer":[]}]},"post":{"operationId":"ScenariosController_create","summary":"","description":"Create a scenario","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateScenarioDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["Scenario"],"security":[{"bearer":[]}]}},"/api/v1/scenarios/{id}":{"get":{"operationId":"ScenariosController_findOne","summary":"","description":"Find scenario by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}}},"404":{"description":"Scenario not found"}},"tags":["Scenario"],"security":[{"bearer":[]}]},"patch":{"operationId":"ScenariosController_update","summary":"","description":"Updates a scenario","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScenarioDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}}},"404":{"description":"Scenario not found"}},"tags":["Scenario"],"security":[{"bearer":[]}]},"delete":{"operationId":"ScenariosController_delete","summary":"","description":"Deletes a scenario","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Scenario not found"}},"tags":["Scenario"],"security":[{"bearer":[]}]}},"/api/v1/scenarios/{id}/interventions":{"get":{"operationId":"ScenariosController_findInterventionsByScenario","summary":"","description":"Find all Interventions that belong to a given Scenario Id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}}},"404":{"description":"Scenario not found"}},"tags":["Scenario"],"security":[{"bearer":[]}]}},"/api/v1/scenario-interventions":{"get":{"operationId":"ScenarioInterventionsController_findAll","summary":"","description":"Find all scenarios","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenarioIntervention"}}}},"401":{"description":""},"403":{"description":""}},"tags":["ScenarioIntervention"],"security":[{"bearer":[]}]},"post":{"operationId":"ScenarioInterventionsController_create","summary":"","description":"Create a scenario intervention","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateScenarioInterventionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenarioIntervention"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["ScenarioIntervention"],"security":[{"bearer":[]}]}},"/api/v1/scenario-interventions/{id}":{"get":{"operationId":"ScenarioInterventionsController_findOne","summary":"","description":"Find scenario intervention by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenarioIntervention"}}}},"404":{"description":"Scenario intervention not found"}},"tags":["ScenarioIntervention"],"security":[{"bearer":[]}]},"patch":{"operationId":"ScenarioInterventionsController_update","summary":"","description":"Update a scenario intervention","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScenarioInterventionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenarioIntervention"}}}},"404":{"description":"Scenario intervention not found"}},"tags":["ScenarioIntervention"],"security":[{"bearer":[]}]},"delete":{"operationId":"ScenarioInterventionsController_delete","summary":"","description":"Delete a scenario intervention","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Scenario intervention not found"}},"tags":["ScenarioIntervention"],"security":[{"bearer":[]}]}},"/api/v1/impact/table":{"get":{"operationId":"ImpactController_getImpactTable","summary":"","description":"Get data for Impact Table","parameters":[{"name":"indicatorIds[]","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"groupBy","required":true,"in":"query","schema":{"enum":["material","business-unit","region","t1Supplier","producer","location-type"],"type":"string"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioId","required":false,"in":"query","description":"Include in the response elements that are being intervened in a Scenario,","schema":{"type":"string"}},{"name":"sortingYear","required":false,"in":"query","description":"Sort all the entities recursively by the impact value corresponding to the sortingYear","schema":{"type":"number"}},{"name":"sortingOrder","required":false,"in":"query","description":"Indicates the order by which the entities will be sorted","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedImpactTable"}}}}},"tags":["Impact"],"security":[{"bearer":[]}]}},"/api/v1/impact/compare/scenario/vs/scenario":{"get":{"operationId":"ImpactController_getTwoScenariosImpactTable","summary":"","description":"Get data for comparing Impacts of 2 Scenarios","parameters":[{"name":"indicatorIds[]","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"groupBy","required":true,"in":"query","schema":{"enum":["material","business-unit","region","t1Supplier","producer","location-type"],"type":"string"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"baseScenarioId","required":false,"in":"query","schema":{"type":"string"}},{"name":"comparedScenarioId","required":false,"in":"query","schema":{"type":"string"}},{"name":"sortingYear","required":false,"in":"query","description":"Sort all the entities recursively by the absolute difference value corresponding to the sortingYear","schema":{"type":"number"}},{"name":"sortingOrder","required":false,"in":"query","description":"Indicates the order by which the entities will be sorted","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScenarioVsScenarioPaginatedImpactTable"}}}}},"tags":["Impact"],"security":[{"bearer":[]}]}},"/api/v1/impact/compare/scenario/vs/actual":{"get":{"operationId":"ImpactController_getActualVsScenarioImpactTable","summary":"","description":"Get data for comapring Actual data with Scenario in form of Impact Table","parameters":[{"name":"indicatorIds[]","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"groupBy","required":true,"in":"query","schema":{"enum":["material","business-unit","region","t1Supplier","producer","location-type"],"type":"string"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"comparedScenarioId","required":true,"in":"query","schema":{"type":"string"}},{"name":"sortingYear","required":false,"in":"query","description":"Sort all the entities recursively by the absolute difference value corresponding to the sortingYear","schema":{"type":"number"}},{"name":"sortingOrder","required":false,"in":"query","description":"Indicates the order by which the entities will be sorted","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedImpactTable"}}}}},"tags":["Impact"],"security":[{"bearer":[]}]}},"/api/v1/impact/ranking":{"get":{"operationId":"ImpactController_getRankedImpactTable","summary":"","description":"Get Ranked Impact Table, up to maxRankingEntities, aggregating the rest of entities, for each indicator ","parameters":[{"name":"indicatorIds[]","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"groupBy","required":true,"in":"query","schema":{"enum":["material","business-unit","region","t1Supplier","producer","location-type"],"type":"string"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"maxRankingEntities","required":true,"in":"query","description":"The maximum number of entities to show in the Impact Table. If the result includes more than that, they will beaggregated into the \"other\" field in the response","schema":{"type":"number"}},{"name":"sort","required":true,"in":"query","description":"The sort order for the resulting entities. Can be 'ASC' (Ascendant) or 'DES' (Descendent), with the default being 'DES'","schema":{"type":"string"}},{"name":"scenarioId","required":false,"in":"query","description":"Include in the response elements that are being intervened in a Scenario,","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpactTable"}}}}},"tags":["Impact"],"security":[{"bearer":[]}]}},"/api/v1/impact/table/report":{"get":{"operationId":"ImpactReportController_getImpactReport","summary":"","description":"Get a Impact Table CSV Report","parameters":[{"name":"indicatorIds[]","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"groupBy","required":true,"in":"query","schema":{"enum":["material","business-unit","region","t1Supplier","producer","location-type"],"type":"string"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioId","required":false,"in":"query","description":"Include in the response elements that are being intervened in a Scenario,","schema":{"type":"string"}},{"name":"sortingYear","required":false,"in":"query","description":"Sort all the entities recursively by the impact value corresponding to the sortingYear","schema":{"type":"number"}},{"name":"sortingOrder","required":false,"in":"query","description":"Indicates the order by which the entities will be sorted","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Impact"]}},"/api/v1/impact/compare/scenario/vs/actual/report":{"get":{"operationId":"ImpactReportController_getActualVsScenarioImpactReport","summary":"","description":"Get a Actual Vs Scenario Impact Table CSV Report for a given scenario","parameters":[{"name":"indicatorIds[]","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"groupBy","required":true,"in":"query","schema":{"enum":["material","business-unit","region","t1Supplier","producer","location-type"],"type":"string"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"comparedScenarioId","required":true,"in":"query","schema":{"type":"string"}},{"name":"sortingYear","required":false,"in":"query","description":"Sort all the entities recursively by the absolute difference value corresponding to the sortingYear","schema":{"type":"number"}},{"name":"sortingOrder","required":false,"in":"query","description":"Indicates the order by which the entities will be sorted","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Impact"]}},"/api/v1/impact/compare/scenario/vs/scenario/report":{"get":{"operationId":"ImpactReportController_getTwoScenariosImpacReport","summary":"","description":"Get a Scenario Vs Scenario Impact Table CSV Report for 2 Scenarios","parameters":[{"name":"indicatorIds[]","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":true,"in":"query","schema":{"type":"number"}},{"name":"groupBy","required":true,"in":"query","schema":{"enum":["material","business-unit","region","t1Supplier","producer","location-type"],"type":"string"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1SupplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"baseScenarioId","required":false,"in":"query","schema":{"type":"string"}},{"name":"comparedScenarioId","required":false,"in":"query","schema":{"type":"string"}},{"name":"sortingYear","required":false,"in":"query","description":"Sort all the entities recursively by the absolute difference value corresponding to the sortingYear","schema":{"type":"number"}},{"name":"sortingOrder","required":false,"in":"query","description":"Indicates the order by which the entities will be sorted","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Impact"]}},"/api/v1/indicators":{"get":{"operationId":"IndicatorsController_findAll","summary":"","description":"Find all indicators","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`, `description`, `status`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Indicator"}}}},"401":{"description":""},"403":{"description":""}},"tags":["Indicator"],"security":[{"bearer":[]}]},"post":{"operationId":"IndicatorsController_create","summary":"","description":"Create a indicator","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIndicatorDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Indicator"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"},"403":{"description":""}},"tags":["Indicator"],"security":[{"bearer":[]}]}},"/api/v1/indicators/{id}":{"get":{"operationId":"IndicatorsController_findOne","summary":"","description":"Find indicator by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Indicator"}}}},"404":{"description":"Indicator not found"}},"tags":["Indicator"],"security":[{"bearer":[]}]},"patch":{"operationId":"IndicatorsController_update","summary":"","description":"Updates a indicator","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIndicatorDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Indicator"}}}},"403":{"description":""},"404":{"description":"Indicator not found"}},"tags":["Indicator"],"security":[{"bearer":[]}]},"delete":{"operationId":"IndicatorsController_delete","summary":"","description":"Deletes a indicator","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"403":{"description":""},"404":{"description":"Indicator not found"}},"tags":["Indicator"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-records":{"get":{"operationId":"SourcingRecordsController_findAll","summary":"","description":"Find all sourcing record","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `tonnage`, `year`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingRecord"}}}},"401":{"description":""},"403":{"description":""}},"tags":["SourcingRecord"],"security":[{"bearer":[]}]},"post":{"operationId":"SourcingRecordsController_create","summary":"","description":"Create a sourcing record","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSourcingRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingRecord"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["SourcingRecord"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-records/years":{"get":{"operationId":"SourcingRecordsController_getYears","summary":"","description":"Find years associated with existing sourcing records","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"List of years","type":"array","items":{"type":"integer","example":2021}}}}}}}},"tags":["SourcingRecord"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-records/{id}":{"get":{"operationId":"SourcingRecordsController_findOne","summary":"","description":"Find sourcing record by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingRecord"}}}},"404":{"description":"Sourcing record not found"}},"tags":["SourcingRecord"],"security":[{"bearer":[]}]},"patch":{"operationId":"SourcingRecordsController_update","summary":"","description":"Updates a sourcing record","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSourcingRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingRecord"}}}},"404":{"description":"Sourcing record not found"}},"tags":["SourcingRecord"],"security":[{"bearer":[]}]},"delete":{"operationId":"SourcingRecordsController_delete","summary":"","description":"Deletes a sourcing record","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Sourcing record not found"}},"tags":["SourcingRecord"],"security":[{"bearer":[]}]}},"/api/v1/indicator-records":{"get":{"operationId":"IndicatorRecordsController_findAll","summary":"","description":"Find all indicator records","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `value`, `status`, `sourcingRecordId`, `indicatorId`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorRecord"}}}},"401":{"description":""},"403":{"description":""}},"tags":["IndicatorRecord"],"security":[{"bearer":[]}]},"post":{"operationId":"IndicatorRecordsController_create","summary":"","description":"Create a indicator record","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIndicatorRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorRecord"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["IndicatorRecord"],"security":[{"bearer":[]}]}},"/api/v1/indicator-records/{id}":{"get":{"operationId":"IndicatorRecordsController_findOne","summary":"","description":"Find indicator record by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorRecord"}}}},"404":{"description":"Indicator record not found"}},"tags":["IndicatorRecord"],"security":[{"bearer":[]}]},"patch":{"operationId":"IndicatorRecordsController_update","summary":"","description":"Updates a indicator record","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIndicatorRecordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorRecord"}}}},"404":{"description":"Indicator record not found"}},"tags":["IndicatorRecord"],"security":[{"bearer":[]}]},"delete":{"operationId":"IndicatorRecordsController_delete","summary":"","description":"Deletes a indicator record","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Indicator record not found"}},"tags":["IndicatorRecord"],"security":[{"bearer":[]}]}},"/api/v1/h3/data/{h3TableName}/{h3ColumnName}":{"get":{"operationId":"H3DataController_getH3ByName","summary":"","description":"Retrieve H3 data providing its name","parameters":[{"name":"h3TableName","required":true,"in":"path","schema":{"type":"string"}},{"name":"h3ColumnName","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/H3DataResponse"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["H3Data"],"security":[{"bearer":[]}]}},"/api/v1/h3/years":{"get":{"operationId":"H3DataController_getYearsByLayerType","summary":"","description":"Retrieve years for which there is data, by layer","parameters":[{"name":"layer","required":true,"in":"query","schema":{"type":"string"}},{"name":"materialIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"indicatorId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"integer","example":2021}}}}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["H3Data"],"security":[{"bearer":[]}]}},"/api/v1/h3/map/material":{"get":{"operationId":"H3DataController_getMaterialMap","summary":"","description":"Get a Material map of h3 indexes by ID in a given resolution","parameters":[{"name":"materialId","required":true,"in":"query","schema":{"type":"string"}},{"name":"resolution","required":true,"in":"query","schema":{"type":"number"}},{"name":"year","required":true,"in":"query","schema":{"type":"number"}},{"name":"materialId","in":"query","required":true,"schema":{"type":"string"}},{"name":"resolution","in":"query","required":true,"schema":{"type":"number"}},{"name":"year","in":"query","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/H3MapResponse"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["H3Data"],"security":[{"bearer":[]}]}},"/api/v1/h3/map/impact":{"get":{"operationId":"H3DataController_getImpactMap","summary":"","description":"Get a calculated H3 impact map given an Indicator, Year and Resolution.","parameters":[{"name":"indicatorId","required":true,"in":"query","schema":{"type":"string"}},{"name":"year","required":true,"in":"query","schema":{"type":"number"}},{"name":"resolution","required":true,"in":"query","schema":{"type":"number"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1supplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"scenarioId","required":false,"in":"query","description":"The scenarioID, whose information will be included in the response. That is, the impact of all indicator records related to the interventions of that scenarioId, will be aggregated into the response map data along the actual data.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/H3MapResponse"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["H3Data"],"security":[{"bearer":[]}]}},"/api/v1/h3/map/impact/compare/actual/vs/scenario":{"get":{"operationId":"H3DataController_getImpactActualVsScenarioComparisonMap","summary":"","description":"Get a calculated H3 impact map given an Indicator, Year and Resolution comparing the actual data against the given Scenario. The resulting map will contain the difference between the actual data and the given scenario data plus actual data","parameters":[{"name":"indicatorId","required":true,"in":"query","schema":{"type":"string"}},{"name":"year","required":true,"in":"query","schema":{"type":"number"}},{"name":"resolution","required":true,"in":"query","schema":{"type":"number"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1supplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"comparedScenarioId","required":true,"in":"query","description":"The id of the scenario against which the actual data will be compared to.","schema":{"type":"string"}},{"name":"relative","required":true,"in":"query","description":"Indicates whether the result will be absolute difference values (false) or relative values in percentages (true)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/H3MapResponse"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["H3Data"],"security":[{"bearer":[]}]}},"/api/v1/h3/map/impact/compare/scenario/vs/scenario":{"get":{"operationId":"H3DataController_getImpactScenarioVsScenarioComparisonMap","summary":"","description":"Get a calculated H3 impact map given an Indicator, Year and Resolution comparing the given Scenario against another Scenario. The resulting map will contain the difference between actual data and the given base scenario data, minus the actual data and the compared Scenario.","parameters":[{"name":"indicatorId","required":true,"in":"query","schema":{"type":"string"}},{"name":"year","required":true,"in":"query","schema":{"type":"number"}},{"name":"resolution","required":true,"in":"query","schema":{"type":"number"}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"t1supplierIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"businessUnitIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"locationTypes[]","required":false,"in":"query","description":"Types of Sourcing Locations, written with hyphens","schema":{"enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"type":"string"}},{"name":"baseScenarioId","required":true,"in":"query","description":"The of the scenario that will be the base for the comparison.","schema":{"type":"string"}},{"name":"comparedScenarioId","required":true,"in":"query","description":"The id of the scenario against which the base Scenario will be compared to.","schema":{"type":"string"}},{"name":"relative","required":true,"in":"query","description":"Indicates whether the result will be absolute difference values (false) or relative values in percentages (true)","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/H3MapResponse"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["H3Data"],"security":[{"bearer":[]}]}},"/api/v1/unit-conversions":{"get":{"operationId":"UnitConversionsController_findAll","summary":"","description":"Find all conversion units","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `unit1`, `unit2`, `factor`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitConversion"}}}},"401":{"description":""},"403":{"description":""}},"tags":["UnitConversion"],"security":[{"bearer":[]}]},"post":{"operationId":"UnitConversionsController_create","summary":"","description":"Create a conversion unit","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUnitConversionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitConversion"}}}}},"tags":["UnitConversion"],"security":[{"bearer":[]}]}},"/api/v1/unit-conversions/{id}":{"get":{"operationId":"UnitConversionsController_findOne","summary":"","description":"Find conversion unit by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitConversion"}}}},"404":{"description":"Conversion unit not found"}},"tags":["UnitConversion"],"security":[{"bearer":[]}]},"patch":{"operationId":"UnitConversionsController_update","summary":"","description":"Updates a conversion unit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUnitConversionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitConversion"}}}},"404":{"description":"Conversion unit not found"}},"tags":["UnitConversion"],"security":[{"bearer":[]}]},"delete":{"operationId":"UnitConversionsController_delete","summary":"","description":"Deletes a conversion unit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Conversion unit not found"}},"tags":["UnitConversion"],"security":[{"bearer":[]}]}},"/api/v1/geo-regions":{"get":{"operationId":"GeoRegionsController_findAll","summary":"","description":"Find all geo regions","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRegion"}}}},"401":{"description":""},"403":{"description":""}},"tags":["GeoRegion"],"security":[{"bearer":[]}]},"post":{"operationId":"GeoRegionsController_create","summary":"","description":"Create a geo region","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGeoRegionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRegion"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["GeoRegion"],"security":[{"bearer":[]}]}},"/api/v1/geo-regions/{id}":{"get":{"operationId":"GeoRegionsController_findOne","summary":"","description":"Find geo region by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRegion"}}}},"404":{"description":"Geo region not found"}},"tags":["GeoRegion"],"security":[{"bearer":[]}]},"patch":{"operationId":"GeoRegionsController_update","summary":"","description":"Updates a geo region","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGeoRegionDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRegion"}}}},"404":{"description":"Geo region not found"}},"tags":["GeoRegion"],"security":[{"bearer":[]}]},"delete":{"operationId":"GeoRegionsController_delete","summary":"","description":"Deletes a geo region","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Geo region not found"}},"tags":["GeoRegion"],"security":[{"bearer":[]}]}},"/api/v1/contextual-layers/categories":{"get":{"operationId":"ContextualLayersController_getContextualLayersByCategory","summary":"","description":"Get all Contextual Layer info grouped by Category","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContextualLayerByCategory"}}}}},"401":{"description":""},"403":{"description":""}},"tags":["ContextualLayer"],"security":[{"bearer":[]}]}},"/api/v1/contextual-layers/{id}/h3data":{"get":{"operationId":"ContextualLayersController_getContextualLayerH3","summary":"","description":"Returns all the H3 index data for this given contextual layer, resolution and optionally year","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"resolution","required":true,"in":"query","schema":{"type":"number"}},{"name":"year","required":false,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContextualLayerH3ResponseDto"}}}},"401":{"description":""},"403":{"description":""}},"tags":["ContextualLayer"],"security":[{"bearer":[]}]}},"/api/v1/import/sourcing-data":{"post":{"operationId":"ImportDataController_importSourcingRecords","summary":"","description":"Upload XLSX dataset","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"XLSX File","format":"binary"}}}}}},"responses":{"201":{"description":""},"400":{"description":"Bad Request. A .XLSX file not provided as payload or contains missing or incorrect data"},"403":{"description":""}},"tags":["Import Data"],"security":[{"bearer":[]}]}},"/api/v1/import/eudr":{"post":{"operationId":"ImportDataController_importEudr","summary":"","description":"Upload XLSX dataset","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"XLSX File","format":"binary"}}}}}},"responses":{"201":{"description":""},"400":{"description":"Bad Request. A .XLSX file not provided as payload or contains missing or incorrect data"},"403":{"description":""}},"tags":["Import Data"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-location-groups":{"get":{"operationId":"SourcingLocationGroupsController_findAll","summary":"","description":"Find all sourcing location groups","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `title`, `description`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocationGroup"}}}},"401":{"description":""},"403":{"description":""}},"tags":["SourcingLocationGroup"],"security":[{"bearer":[]}]},"post":{"operationId":"SourcingLocationGroupsController_create","summary":"","description":"Create a sourcing location group","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSourcingLocationGroupDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocationGroup"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["SourcingLocationGroup"],"security":[{"bearer":[]}]}},"/api/v1/sourcing-location-groups/{id}":{"get":{"operationId":"SourcingLocationGroupsController_findOne","summary":"","description":"Find sourcing location group by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocationGroup"}}}},"404":{"description":"Sourcing location group not found"}},"tags":["SourcingLocationGroup"],"security":[{"bearer":[]}]},"patch":{"operationId":"SourcingLocationGroupsController_update","summary":"","description":"Updates a sourcing location group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSourcingLocationGroupDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourcingLocationGroup"}}}},"404":{"description":"Sourcing location group not found"}},"tags":["SourcingLocationGroup"],"security":[{"bearer":[]}]},"delete":{"operationId":"SourcingLocationGroupsController_delete","summary":"","description":"Deletes a sourcing location group","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Sourcing location group not found"}},"tags":["SourcingLocationGroup"],"security":[{"bearer":[]}]}},"/api/v1/tasks":{"get":{"operationId":"TasksController_findAll","summary":"","description":"Find all tasks","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned. Allowed values are: `user`.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `status`, `data`, `createdBy`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":""},"401":{"description":""},"403":{"description":""}},"tags":["Task"],"security":[{"bearer":[]}]},"post":{"operationId":"TasksController_create","summary":"","description":"Create a Task","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaskDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["Task"],"security":[{"bearer":[]}]}},"/api/v1/tasks/{id}":{"get":{"operationId":"TasksController_findOne","summary":"","description":"Find task by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned. Allowed values are: `user`.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"400":{"description":""},"401":{"description":""},"403":{"description":""}},"tags":["Task"],"security":[{"bearer":[]}]},"patch":{"operationId":"TasksController_update","summary":"","description":"Updates a task","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"404":{"description":"Task not found"}},"tags":["Task"],"security":[{"bearer":[]}]},"delete":{"operationId":"TasksController_delete","summary":"","description":"Deletes a task","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Task not found"}},"tags":["Task"],"security":[{"bearer":[]}]}},"/api/v1/tasks/report/errors/{id}":{"get":{"operationId":"TasksController_getErrorsReport","summary":"","description":"Get a CSV report of errors by Task Id and type","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"type","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Task not found"}},"tags":["Task"],"security":[{"bearer":[]}]}},"/api/v1/indicator-coefficients":{"get":{"operationId":"IndicatorCoefficientsController_findAll","summary":"","description":"Find all indicator coefficients","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `value`, `year`, `indicatorSourceId`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorCoefficient"}}}},"401":{"description":""},"403":{"description":""}},"tags":["IndicatorCoefficient"],"security":[{"bearer":[]}]},"post":{"operationId":"IndicatorCoefficientsController_create","summary":"","description":"Create a indicator coefficient","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIndicatorCoefficientDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorCoefficient"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["IndicatorCoefficient"],"security":[{"bearer":[]}]}},"/api/v1/indicator-coefficients/{id}":{"get":{"operationId":"IndicatorCoefficientsController_findOne","summary":"","description":"Find indicator coefficient by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorCoefficient"}}}},"404":{"description":"Indicator coefficient not found"}},"tags":["IndicatorCoefficient"],"security":[{"bearer":[]}]},"patch":{"operationId":"IndicatorCoefficientsController_update","summary":"","description":"Updates a indicator coefficient","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIndicatorCoefficientDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndicatorCoefficient"}}}},"404":{"description":"Indicator coefficient not found"}},"tags":["IndicatorCoefficient"],"security":[{"bearer":[]}]},"delete":{"operationId":"IndicatorCoefficientsController_delete","summary":"","description":"Deletes a indicator coefficient","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Indicator coefficient not found"}},"tags":["IndicatorCoefficient"],"security":[{"bearer":[]}]}},"/api/v1/targets":{"get":{"operationId":"TargetsController_findAll","summary":"","description":"Find all targets","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"}}}},"400":{"description":""},"401":{"description":""},"403":{"description":""}},"tags":["Target"],"security":[{"bearer":[]}]},"post":{"operationId":"TargetsController_create","summary":"","description":"Create a target","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTargetDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["Target"],"security":[{"bearer":[]}]}},"/api/v1/targets/{id}":{"get":{"operationId":"TargetsController_findOne","summary":"","description":"Find target by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"}}}},"404":{"description":"Target not found"}},"tags":["Target"],"security":[{"bearer":[]}]},"patch":{"operationId":"TargetsController_update","summary":"","description":"Updates a target","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTargetDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Target"}}}},"404":{"description":"Target not found"}},"tags":["Target"],"security":[{"bearer":[]}]},"delete":{"operationId":"TargetsController_delete","summary":"","description":"Deletes a target","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Target not found"}},"tags":["Target"],"security":[{"bearer":[]}]}},"/api/v1/units":{"get":{"operationId":"UnitsController_findAll","summary":"","description":"Find all units","parameters":[{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`, `description`, `symbol`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}}}},"401":{"description":""},"403":{"description":""}},"tags":["Unit"],"security":[{"bearer":[]}]},"post":{"operationId":"UnitsController_create","summary":"","description":"Create a unit","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUnitDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["Unit"],"security":[{"bearer":[]}]}},"/api/v1/units/{id}":{"get":{"operationId":"UnitsController_findOne","summary":"","description":"Find unit by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}}}},"404":{"description":"Unit not found"}},"tags":["Unit"],"security":[{"bearer":[]}]},"patch":{"operationId":"UnitsController_update","summary":"","description":"Updates a unit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUnitDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unit"}}}},"404":{"description":"Unit not found"}},"tags":["Unit"],"security":[{"bearer":[]}]},"delete":{"operationId":"UnitsController_delete","summary":"","description":"Deletes a unit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"Unit not found"}},"tags":["Unit"],"security":[{"bearer":[]}]}},"/api/v1/url-params/{id}":{"get":{"operationId":"UrlParamsController_findOne","summary":"","description":"Find URL params set by id","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializedUrlResponseDto"}}}},"404":{"description":"URL params not found"}},"tags":["UrlParam"],"security":[{"bearer":[]}]},"delete":{"operationId":"UrlParamsController_delete","summary":"","description":"Deletes a set of URL Params","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""},"404":{"description":"URL Params not found"}},"tags":["UrlParam"],"security":[{"bearer":[]}]}},"/api/v1/url-params":{"post":{"operationId":"UrlParamsController_create","summary":"","description":"Save URL params set","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerializedUrlResponseDto"}}}},"400":{"description":"Bad Request. Incorrect or missing parameters"}},"tags":["UrlParam"],"security":[{"bearer":[]}]}},"/api/v1/eudr/suppliers":{"get":{"operationId":"EudrController_getSuppliers","summary":"","description":"Find all EUDR suppliers and return them in a flat format. Data in the \"children\" will recursively extend for the full depth of the tree","parameters":[{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Supplier"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/Supplier"}}}}]}}}},"401":{"description":""},"403":{"description":""}},"tags":["EUDR"]}},"/api/v1/eudr/materials":{"get":{"operationId":"EudrController_getMaterialsTree","summary":"","description":"Find all EUDR materials and return them in a tree format. Data in the \"children\" will recursively extend for the full depth of the tree","parameters":[{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Material"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/Material"}}}}]}}}},"401":{"description":""},"403":{"description":""}},"tags":["EUDR"]}},"/api/v1/eudr/admin-regions":{"get":{"operationId":"EudrController_getTreesForEudr","summary":"","description":"Find all EUDR admin regions and return them in a tree format. Data in the \"children\" will recursively extend for the full depth of the tree","parameters":[{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AdminRegion"},{"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/AdminRegion"}}}}]}}}},"401":{"description":""},"403":{"description":""}},"tags":["EUDR"]}},"/api/v1/eudr/geo-regions":{"get":{"operationId":"EudrController_findAllEudr","summary":"","description":"Find all EUDR geo regions","parameters":[{"name":"producerIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"originIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"materialIds[]","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"include","required":false,"in":"query","description":"A comma-separated list of relationship paths. Allows the client to customize which related resources should be returned.","schema":{"type":"string"}},{"name":"filter","required":false,"in":"query","description":"An array of filters (e.g. `filter[keyA]=<value>&filter[keyB]=<value1>,<value2>...`). Allows the client to request for specific filtering criteria to be applied to the request. Semantics of each set of filter key/values and of the set of filters as a whole depend on the specific request. Available filters: `name`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"fields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of the fields to be returned. An empty value indicates that all fields will be returned (less any fields specified as `omitFields`).","schema":{"type":"string"}},{"name":"omitFields","required":false,"in":"query","description":"A comma-separated list that refers to the name(s) of fields to be omitted from the results. This could be useful as a shortcut when a specific field such as large geometry fields should be omitted, but it is not practical or not desirable to explicitly whitelist fields individually. An empty value indicates that no fields will be omitted (although they may still not be present in the result if an explicit choice of fields was provided via `fields`).","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"A comma-separated list of fields of the primary data according to which the results should be sorted. Sort order is ascending unless the field name is prefixed with a minus (for descending order).","schema":{"type":"string"}},{"name":"page[size]","required":false,"in":"query","description":"Page size for pagination. If not supplied, pagination with default page size of 25 elements will be applied.","schema":{"type":"number"}},{"name":"page[number]","required":false,"in":"query","description":"Page number for pagination. If not supplied, the first page of results will be returned.","schema":{"type":"number"}},{"name":"disablePagination","required":false,"in":"query","description":"If set to `true`, pagination will be disabled. This overrides any other pagination query parameters, if supplied.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeoRegion"}}}}},"401":{"description":""},"403":{"description":""}},"tags":["EUDR"]}},"/api/v1/eudr/dates":{"get":{"operationId":"EudrController_getAlertDates","summary":"","description":"Get EUDR alerts dates","parameters":[{"name":"supplierIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"geoRegionIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":false,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":false,"in":"query","schema":{"type":"number"}},{"name":"startAlertDate","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"endAlertDate","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EUDRAlertDates"}}}}},"401":{"description":""},"403":{"description":""}},"tags":["EUDR"]}},"/api/v1/eudr/alerts":{"get":{"operationId":"EudrController_getAlerts","parameters":[{"name":"supplierIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"geoRegionIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"startYear","required":false,"in":"query","schema":{"type":"number"}},{"name":"endYear","required":false,"in":"query","schema":{"type":"number"}},{"name":"startAlertDate","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"endAlertDate","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"tags":["EUDR"]}},"/api/v1/eudr/geo-features":{"get":{"operationId":"EudrController_getGeoFeatureList","summary":"","description":"Get a Feature List GeoRegion Ids","parameters":[{"name":"geoRegionIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GeoFeatureResponse"}}}}},"401":{"description":""},"403":{"description":""}},"tags":["EUDR"]}},"/api/v1/eudr/geo-features/collection":{"get":{"operationId":"EudrController_getGeoFeatureCollection","summary":"","description":"Get a Feature Collection by GeoRegion Ids","parameters":[{"name":"geoRegionIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoFeatureCollectionResponse"}}}},"401":{"description":""},"403":{"description":""}},"tags":["EUDR"]}}},"info":{"title":"LandGriffon API","description":"LandGriffon is a conservation planning platform.","version":"0.2.0","contact":{}},"tags":[],"servers":[],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"GeoRegion":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"theGeom":{"type":"object"},"adminRegions":{"type":"array","items":{"type":"string"}},"sourcingLocations":{"type":"array","items":{"type":"string"}}},"required":["id"]},"AdminRegion":{"type":"object","properties":{"id":{"type":"string"},"parent":{"$ref":"#/components/schemas/AdminRegion"},"parentId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"isoA2":{"type":"string"},"isoA3":{"type":"string"},"sourcingLocations":{"type":"array","items":{"type":"string"}},"geoRegion":{"$ref":"#/components/schemas/GeoRegion"},"geoRegionId":{"type":"string"}},"required":["id","status","geoRegion"]},"CreateAdminRegionDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"isoA2":{"type":"string"},"isoA3":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"}},"required":["name"]},"UpdateAdminRegionDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"isoA2":{"type":"string"},"isoA3":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"}}},"Material":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"parentId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"hsCodeId":{"type":"string"},"earthstatId":{"type":"string"},"mapspamId":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"object"}},"required":["createdAt","updatedAt","id","name","status"]},"CreateMaterialDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"},"parentId":{"type":"string"},"hsCodeId":{"type":"string"},"earthstatId":{"type":"string"},"mapspamId":{"type":"string"}},"required":["name","hsCodeId"]},"UpdateMaterialDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"},"parentId":{"type":"string"},"hsCodeId":{"type":"string"},"earthstatId":{"type":"string"},"mapspamId":{"type":"string"}}},"Supplier":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"parentId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"companyId":{"type":"string"},"address":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"object"}},"required":["createdAt","updatedAt","id","name","status"]},"CreateSupplierDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"},"parentId":{"type":"string"}},"required":["name"]},"UpdateSupplierDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"},"parentId":{"type":"string"}}},"BusinessUnit":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"object"}},"required":["id","name","status"]},"CreateBusinessUnitDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"}},"required":["name"]},"UpdateBusinessUnitDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"string"}}},"SourcingLocation":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"locationLatitude":{"type":"number"},"locationLongitude":{"type":"number"},"locationType":{"type":"string"},"locationAddressInput":{"type":"string"},"locationCountryInput":{"type":"string"},"locationAccuracy":{"type":"string"},"locationWarning":{"type":"string"},"geoRegionId":{"type":"string"},"metadata":{"type":"object"},"materialId":{"type":"string"},"adminRegionId":{"type":"string"},"businessUnitId":{"type":"string"},"sourcingLocationGroupId":{"type":"string"},"interventionType":{"type":"string"},"scenarioInterventionId":{"type":"string"}},"required":["createdAt","updatedAt","id","locationType","locationAccuracy"]},"SourcingLocationsMaterialsResponseDto":{"type":"object","properties":{"meta":{"type":"object","properties":{"totalItems":{"type":"number","example":45},"totalPages":{"type":"number","example":9},"size":{"type":"number","example":5},"page":{"type":"number","example":1}}},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"sourcing locations"},"id":{"type":"string","example":"a2428cbb-e1b1-4313-ad85-9579b260387f"},"attributes":{"type":"object","properties":{"locationType":{"type":"string","example":"point of production"},"material":{"type":"string","example":"bananas"},"materialId":{"type":"string","example":"cdde28a2-5692-401b-a1a7-6c68ad38010f"},"t1Supplier":{"type":"string","example":"Cargill"},"producer":{"type":"string","example":"Moll"},"businessUnit":{"type":"string","example":"Accessories"},"locationCountryInput":{"type":"string","example":"Japan"},"purchases":{"type":"array","items":{"type":"object","properties":{"year":{"type":"number","example":2010},"tonnage":{"type":"number","example":730}}}}}}}}}},"required":["meta","data"]},"LocationTypesDto":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}}}}},"required":["data"]},"CreateSourcingLocationDto":{"type":"object","properties":{"title":{"type":"string"},"businessUnitId":{"type":"string"},"materialId":{"type":"string"},"t1SupplierId":{"type":"string"},"producerId":{"type":"string"},"locationType":{"type":"string"},"locationAddressInput":{"type":"string"},"locationCountryInput":{"type":"string"},"locationAccuracy":{"type":"string"},"locationLatitude":{"type":"number"},"locationLongitude":{"type":"number"},"metadata":{"type":"object"},"sourcingLocationGroupId":{"type":"string"}},"required":["title","materialId"]},"UpdateSourcingLocationDto":{"type":"object","properties":{"title":{"type":"string"},"businessUnitId":{"type":"string"},"materialId":{"type":"string"},"t1SupplierId":{"type":"string"},"producerId":{"type":"string"},"locationType":{"type":"string"},"locationAddressInput":{"type":"string"},"locationCountryInput":{"type":"string"},"locationAccuracy":{"type":"string"},"locationLatitude":{"type":"number"},"locationLongitude":{"type":"number"},"metadata":{"type":"object"},"sourcingLocationGroupId":{"type":"string"}}},"LoginDto":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"]},"AccessToken":{"type":"object","properties":{"user":{"type":"object"},"accessToken":{"type":"string"}},"required":["user","accessToken"]},"ResetPasswordDto":{"type":"object","properties":{"password":{"type":"string"}},"required":["password"]},"Permission":{"type":"object","properties":{"action":{"type":"string"}},"required":["action"]},"Role":{"type":"object","properties":{"name":{"type":"string","enum":["admin","user"]},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"}}},"required":["name","permissions"]},"User":{"type":"object","properties":{"email":{"type":"string"},"title":{"type":"string"},"fname":{"type":"string"},"lname":{"type":"string"},"avatarDataUrl":{"type":"string"},"isActive":{"type":"boolean"},"isDeleted":{"type":"boolean"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}},"required":["email","isActive","isDeleted","roles"]},"JSONAPIUserData":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/User"}},"required":["type","id","attributes"]},"ApiEvent":{"type":"object","properties":{"kind":{"type":"string"},"topic":{"type":"string"}},"required":["kind","topic"]},"JSONAPIApiEventData":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/ApiEvent"}},"required":["type","id","attributes"]},"ApiEventResult":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JSONAPIApiEventData"}},"required":["data"]},"CreateApiEventDTO":{"type":"object","properties":{"kind":{"type":"string"},"topic":{"type":"string"},"data":{"type":"object"}},"required":["kind","topic"]},"CreateUserDTO":{"type":"object","properties":{"email":{"type":"string"},"title":{"type":"object"},"fname":{"type":"object"},"lname":{"type":"object"},"password":{"type":"string"},"avatarDataUrl":{"type":"string"},"roles":{"type":"array","example":["admin","user"],"items":{"type":"string","enum":["admin","user"]}}},"required":["email","password","roles"]},"UpdateUserPasswordDTO":{"type":"object","properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"required":["currentPassword","newPassword"]},"UserResult":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JSONAPIUserData"}},"required":["data"]},"UpdateOwnUserDTO":{"type":"object","properties":{"email":{"type":"string"},"title":{"type":"object"},"fname":{"type":"object"},"lname":{"type":"object"},"avatarDataUrl":{"type":"string"}},"required":["email"]},"RecoverPasswordDto":{"type":"object","properties":{}},"UpdateUserDTO":{"type":"object","properties":{"email":{"type":"string"},"title":{"type":"object"},"fname":{"type":"object"},"lname":{"type":"object"},"password":{"type":"string"},"avatarDataUrl":{"type":"string"},"roles":{"type":"array","example":["admin","user"],"items":{"type":"string","enum":["admin","user"]}}}},"Scenario":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"isPublic":{"type":"boolean","description":"Make a Scenario public to all users"},"status":{"type":"string","enum":["active","inactive","deleted"]},"metadata":{"type":"object"},"user":{"$ref":"#/components/schemas/User"},"userId":{"type":"string"},"updatedBy":{"$ref":"#/components/schemas/User"},"updatedById":{"type":"string"}},"required":["createdAt","updatedAt","id","title","status","user","updatedBy"]},"CreateScenarioDto":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"isPublic":{"type":"boolean"},"metadata":{"type":"string"}},"required":["title"]},"UpdateScenarioDto":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"isPublic":{"type":"boolean"},"metadata":{"type":"string"}}},"ScenarioIntervention":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"startYear":{"type":"number"},"endYear":{"type":"number"},"percentage":{"type":"number"},"newIndicatorCoefficients":{"type":"object"},"scenario":{"$ref":"#/components/schemas/Scenario"},"newMaterial":{"$ref":"#/components/schemas/Material"},"newBusinessUnit":{"$ref":"#/components/schemas/BusinessUnit"},"newT1Supplier":{"$ref":"#/components/schemas/Supplier"},"newProducer":{"$ref":"#/components/schemas/Supplier"},"newAdminRegion":{"$ref":"#/components/schemas/AdminRegion"},"newLocationType":{"type":"string"},"newLocationCountryInput":{"type":"string"},"newLocationAddressInput":{"type":"string"},"newLocationLatitudeInput":{"type":"number"},"newLocationLongitudeInput":{"type":"number"},"newMaterialTonnageRatio":{"type":"number"},"updatedBy":{"$ref":"#/components/schemas/User"},"updatedById":{"type":"string"}},"required":["createdAt","updatedAt","id","title","status","type","startYear","percentage","newIndicatorCoefficients","scenario","updatedBy"]},"IndicatorCoefficientsDto":{"type":"object","properties":{"LF":{"type":"number"},"DF_SLUC":{"type":"number"},"GHG_DEF_SLUC":{"type":"number"},"UWU":{"type":"number"},"WU":{"type":"number"},"NL":{"type":"number"},"NCE":{"type":"number"},"FLIL":{"type":"number"},"ENL":{"type":"number"},"GHG_FARM":{"type":"number"}}},"CreateScenarioInterventionDto":{"type":"object","properties":{"title":{"type":"string","description":"Title of the Intervention","example":"Replace cotton"},"description":{"type":"string","description":"Brief description of the Intervention","example":"This intervention will replace cotton for wool"},"type":{"type":"string","description":"Type of the Intervention","enum":["default","Source from new supplier or location","Change production efficiency","Switch to a new material"],"example":"Switch to a new material"},"startYear":{"type":"number","description":"Start year of the Intervention","example":2022},"endYear":{"type":"number","description":"End year of the Intervention","example":2025},"percentage":{"type":"number","description":"Percentage of the chosen sourcing records affected by intervention","example":50},"scenarioId":{"type":"uuid","description":"Id of Scenario the intervention belongs to","example":"a15e4933-cd9a-4afc-bd53-56941b816ef3"},"materialIds":{"description":"Ids of Materials that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b816ef3","type":"array","items":{"type":"string"}},"businessUnitIds":{"description":"Ids of Business Units that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b812345","type":"array","items":{"type":"string"}},"t1SupplierIds":{"description":"Ids of T1 Suppliers that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b865432","type":"array","items":{"type":"string"}},"producerIds":{"description":"Ids of Producers that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b865432","type":"array","items":{"type":"string"}},"adminRegionIds":{"description":"Ids of Admin Regions that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b8adca3","type":"array","items":{"type":"string"}},"newIndicatorCoefficients":{"$ref":"#/components/schemas/IndicatorCoefficientsDto"},"newT1SupplierId":{"type":"string","description":"Id of the New Supplier","example":"bc5e4933-cd9a-4afc-bd53-56941b8adc111"},"newProducerId":{"type":"string","description":"Id of the New Producer","example":"bc5e4933-cd9a-4afc-bd53-56941b8adc222"},"newLocationType":{"type":"string","description":"Type of new Supplier Location, is required for Intervention types: Switch to a new material and Source from new supplier or location","enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"example":"point-of-production"},"newLocationCountryInput":{"type":"string","description":"New Supplier Location country, is required for Intervention types: Switch to a new material, Source from new supplier or location","example":"Spain"},"newLocationAdminRegionInput":{"type":"string","description":"New Administrative Region, is required for Intervention types: Switch to a new material, Source from new supplier or location\n for Location Type: administrative-region-of-production","example":"Murcia"},"newLocationAddressInput":{"type":"string","description":"\n New Supplier Location address, is required for Intervention types: Switch to a new material, Source from new supplier or location\n and New Supplier Locations of types: point-of-production and production-aggregation-point in case no coordintaes were provided.\n Address OR coordinates must be provided.\n\n Must be NULL for New Supplier Locations of types: unknown and country-of-production\n or if coordinates are provided for the relevant location types","example":"Main Street, 1"},"newLocationLatitude":{"type":"number","description":"\n New Supplier Location latitude, is required for Intervention types: Switch to a new material, Source from new supplier or location\n and New Supplier Locations of types: point-of-production and production-aggregation-point in case no address was provided.\n Address OR coordinates must be provided.\n\n Must be NULL for New Supplier Locations of types: unknown and country-of-production\n or if address is provided for the relevant location types.","minimum":-90,"maximum":90,"example":30.123},"newLocationLongitude":{"type":"number","description":"\n New Supplier Location longitude, is required for Intervention types: Switch to a new material, Source from new supplier or location\n and New Supplier Locations of types: point-of-production and production-aggregation-point in case no address was provided.\n Address OR coordinates must be provided.\n\n Must be NULL for New Supplier Locations of type: unknown and country-of-production\n or if address is provided for the relevant location types.","minimum":-180,"maximum":180,"example":100.123},"newMaterialId":{"type":"string","description":"Id of the New Material, is required if Intervention type is Switch to a new material","example":"bc5e4933-cd9a-4afc-bd53-56941b8adc444"},"newMaterialTonnageRatio":{"type":"number","description":"New Material tonnage ratio","example":0.5}},"required":["title","type","startYear","percentage","scenarioId","materialIds","adminRegionIds","newLocationCountryInput","newLocationAdminRegionInput"]},"UpdateScenarioInterventionDto":{"type":"object","properties":{"title":{"type":"string","description":"Title of the Intervention","example":"Replace cotton"},"description":{"type":"string","description":"Brief description of the Intervention","example":"This intervention will replace cotton for wool"},"type":{"type":"string","description":"Type of the Intervention","enum":["default","Source from new supplier or location","Change production efficiency","Switch to a new material"],"example":"Switch to a new material"},"startYear":{"type":"number","description":"Start year of the Intervention","example":2022},"endYear":{"type":"number","description":"End year of the Intervention","example":2025},"percentage":{"type":"number","description":"Percentage of the chosen sourcing records affected by intervention","example":50},"scenarioId":{"type":"uuid","description":"Id of Scenario the intervention belongs to","example":"a15e4933-cd9a-4afc-bd53-56941b816ef3"},"materialIds":{"description":"Ids of Materials that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b816ef3","type":"array","items":{"type":"string"}},"businessUnitIds":{"description":"Ids of Business Units that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b812345","type":"array","items":{"type":"string"}},"t1SupplierIds":{"description":"Ids of T1 Suppliers that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b865432","type":"array","items":{"type":"string"}},"producerIds":{"description":"Ids of Producers that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b865432","type":"array","items":{"type":"string"}},"adminRegionIds":{"description":"Ids of Admin Regions that will be affected by intervention","example":"bc5e4933-cd9a-4afc-bd53-56941b8adca3","type":"array","items":{"type":"string"}},"newIndicatorCoefficients":{"$ref":"#/components/schemas/IndicatorCoefficientsDto"},"newT1SupplierId":{"type":"string","description":"Id of the New Supplier","example":"bc5e4933-cd9a-4afc-bd53-56941b8adc111"},"newProducerId":{"type":"string","description":"Id of the New Producer","example":"bc5e4933-cd9a-4afc-bd53-56941b8adc222"},"newLocationType":{"type":"string","description":"Type of new Supplier Location, is required for Intervention types: Switch to a new material and Source from new supplier or location","enum":["unknown","production-aggregation-point","point-of-production","country-of-production","administrative-region-of-production","country-of-delivery","eudr"],"example":"point-of-production"},"newLocationCountryInput":{"type":"string","description":"New Supplier Location country, is required for Intervention types: Switch to a new material, Source from new supplier or location","example":"Spain"},"newLocationAdminRegionInput":{"type":"string","description":"New Administrative Region, is required for Intervention types: Switch to a new material, Source from new supplier or location\n for Location Type: administrative-region-of-production","example":"Murcia"},"newLocationAddressInput":{"type":"string","description":"\n New Supplier Location address, is required for Intervention types: Switch to a new material, Source from new supplier or location\n and New Supplier Locations of types: point-of-production and production-aggregation-point in case no coordintaes were provided.\n Address OR coordinates must be provided.\n\n Must be NULL for New Supplier Locations of types: unknown and country-of-production\n or if coordinates are provided for the relevant location types","example":"Main Street, 1"},"newLocationLatitude":{"type":"number","description":"\n New Supplier Location latitude, is required for Intervention types: Switch to a new material, Source from new supplier or location\n and New Supplier Locations of types: point-of-production and production-aggregation-point in case no address was provided.\n Address OR coordinates must be provided.\n\n Must be NULL for New Supplier Locations of types: unknown and country-of-production\n or if address is provided for the relevant location types.","minimum":-90,"maximum":90,"example":30.123},"newLocationLongitude":{"type":"number","description":"\n New Supplier Location longitude, is required for Intervention types: Switch to a new material, Source from new supplier or location\n and New Supplier Locations of types: point-of-production and production-aggregation-point in case no address was provided.\n Address OR coordinates must be provided.\n\n Must be NULL for New Supplier Locations of type: unknown and country-of-production\n or if address is provided for the relevant location types.","minimum":-180,"maximum":180,"example":100.123},"newMaterialId":{"type":"string","description":"Id of the New Material, is required if Intervention type is Switch to a new material","example":"bc5e4933-cd9a-4afc-bd53-56941b8adc444"},"newMaterialTonnageRatio":{"type":"number","description":"New Material tonnage ratio","example":0.5},"status":{"type":"string","description":"Status of the intervention","enum":["active","inactive","deleted"],"example":"inactive"}}},"ImpactTableRowsValues":{"type":"object","properties":{"year":{"type":"number"},"isProjected":{"type":"boolean"},"value":{"type":"number"}},"required":["year","isProjected","value"]},"ImpactTableRows":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/ImpactTableRowsValues"}},"children":{"type":"array","items":{"type":"object"}}},"required":["name","values","children"]},"YearSumData":{"type":"object","properties":{"value":{"type":"number"}},"required":["value"]},"ImpactTableDataAggregationInfo":{"type":"object","properties":{}},"ImpactTableDataByIndicator":{"type":"object","properties":{"indicatorShortName":{"type":"string"},"indicatorId":{"type":"string"},"groupBy":{"type":"string"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ImpactTableRows"}},"yearSum":{"type":"array","items":{"$ref":"#/components/schemas/YearSumData"}},"metadata":{"type":"object"},"others":{"description":"Extra information used for Ranked ImpactTable requests. Missing on normal ImpactTable requests","allOf":[{"$ref":"#/components/schemas/ImpactTableDataAggregationInfo"}]}},"required":["indicatorShortName","indicatorId","groupBy","rows","yearSum","metadata"]},"ImpactTablePurchasedTonnes":{"type":"object","properties":{"year":{"type":"number"},"value":{"type":"number"},"isProjected":{"type":"boolean"}},"required":["year","value","isProjected"]},"ImpactTable":{"type":"object","properties":{"impactTable":{"type":"array","items":{"$ref":"#/components/schemas/ImpactTableDataByIndicator"}},"purchasedTonnes":{"type":"array","items":{"$ref":"#/components/schemas/ImpactTablePurchasedTonnes"}}},"required":["impactTable","purchasedTonnes"]},"PaginationMeta":{"type":"object","properties":{}},"PaginatedImpactTable":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImpactTable"},"metadata":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","metadata"]},"ScenarioVsScenarioImpactTableRowsValues":{"type":"object","properties":{"year":{"type":"number"},"isProjected":{"type":"boolean"},"baseScenarioValue":{"type":"number"},"comparedScenarioValue":{"type":"number"},"absoluteDifference":{"type":"number"},"percentageDifference":{"type":"number"}},"required":["year","isProjected","baseScenarioValue","comparedScenarioValue","absoluteDifference","percentageDifference"]},"ScenarioVsScenarioImpactTableRows":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioVsScenarioImpactTableRowsValues"}},"children":{"type":"array","items":{"type":"object"}}},"required":["name","values","children"]},"ScenarioVsScenarioIndicatorSumByYearData":{"type":"object","properties":{"year":{"type":"number"},"isProjected":{"type":"boolean"},"baseScenarioValue":{"type":"number"},"comparedScenarioValue":{"type":"number"},"absoluteDifference":{"type":"number"},"percentageDifference":{"type":"number"}},"required":["year","isProjected","baseScenarioValue","comparedScenarioValue","absoluteDifference","percentageDifference"]},"ScenarioVsScenarioImpactTableDataByIndicator":{"type":"object","properties":{"indicatorShortName":{"type":"string"},"indicatorId":{"type":"string"},"groupBy":{"type":"string"},"rows":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioVsScenarioImpactTableRows"}},"yearSum":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioVsScenarioIndicatorSumByYearData"}},"metadata":{"type":"object"}},"required":["indicatorShortName","indicatorId","groupBy","rows","yearSum","metadata"]},"ScenarioVsScenarioImpactTablePurchasedTonnes":{"type":"object","properties":{"year":{"type":"number"},"value":{"type":"number"},"isProjected":{"type":"boolean"}},"required":["year","value","isProjected"]},"ScenarioVsScenarioImpactTable":{"type":"object","properties":{"impactTable":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioVsScenarioImpactTableDataByIndicator"}},"purchasedTonnes":{"type":"array","items":{"$ref":"#/components/schemas/ScenarioVsScenarioImpactTablePurchasedTonnes"}}},"required":["impactTable","purchasedTonnes"]},"ScenarioVsScenarioPaginatedImpactTable":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScenarioVsScenarioImpactTable"},"metadata":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","metadata"]},"Indicator":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"metadata":{"type":"object"},"indicatorCoefficients":{"type":"array","items":{"type":"string"}}},"required":["id","name","status"]},"CreateIndicatorDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"nameCode":{"type":"string"},"metadata":{"type":"string"}},"required":["name","nameCode"]},"UpdateIndicatorDto":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string"},"nameCode":{"type":"string"},"metadata":{"type":"string"}}},"SourcingRecord":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"tonnage":{"type":"number"},"year":{"type":"number"},"metadata":{"type":"object"},"updatedBy":{"type":"string"}},"required":["createdAt","updatedAt","id","tonnage","year","updatedBy"]},"CreateSourcingRecordDto":{"type":"object","properties":{"tonnage":{"type":"number"},"year":{"type":"number"},"sourcingLocationsId":{"type":"string"}},"required":["tonnage","year"]},"UpdateSourcingRecordDto":{"type":"object","properties":{"tonnage":{"type":"number"},"year":{"type":"number"},"sourcingLocationsId":{"type":"string"}}},"IndicatorRecord":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"value":{"type":"number"},"status":{"type":"string"},"statusMsg":{"type":"string"}},"required":["createdAt","updatedAt","id","value","status","statusMsg"]},"CreateIndicatorRecordDto":{"type":"object","properties":{"value":{"type":"number"},"sourcingRecordId":{"type":"string"},"indicatorId":{"type":"string"},"indicatorCoefficientId":{"type":"string"},"status":{"type":"string"},"statusMsg":{"type":"string"}},"required":["value","indicatorId"]},"UpdateIndicatorRecordDto":{"type":"object","properties":{"value":{"type":"number"},"year":{"type":"number"},"status":{"type":"string"}}},"H3DataResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"h":{"type":"string"},"v":{"type":"number"}}}}},"required":["data"]},"H3MapResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"h":{"type":"string"},"v":{"type":"number"}}}},"metadata":{"type":"object","properties":{"unit":{"type":"string"},"quantiles":{"type":"array","items":{"type":"number"}},"indicatorDataYear":{"type":"number"},"materialsH3DataYears":{"type":"array","items":{"type":"object","properties":{"materialName":{"type":"string"},"materialDataYear":{"type":"number"},"materialDataType":{"type":"string"}}}}}}},"required":["data","metadata"]},"UnitConversion":{"type":"object","properties":{"id":{"type":"string"},"unit1":{"type":"number"},"unit2":{"type":"number"},"factor":{"type":"number"}},"required":["id"]},"CreateUnitConversionDto":{"type":"object","properties":{"unit1":{"type":"number"},"unit2":{"type":"number"},"factor":{"type":"number"}}},"UpdateUnitConversionDto":{"type":"object","properties":{"unit1":{"type":"number"},"unit2":{"type":"number"},"factor":{"type":"number"}}},"CreateGeoRegionDto":{"type":"object","properties":{"name":{"type":"string"},"h3Compact":{"type":"array","items":{"type":"string"}},"theGeom":{"type":"string"}}},"UpdateGeoRegionDto":{"type":"object","properties":{"name":{"type":"string"},"h3Compact":{"type":"array","items":{"type":"string"}},"theGeom":{"type":"string"}}},"ContextualLayerByCategory":{"type":"object","properties":{}},"GetContextualLayerH3ResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"h":{"type":"string"},"v":{"type":"number"}}}}},"required":["data"]},"SourcingLocationGroup":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"metadata":{"type":"object"},"updatedById":{"type":"string"}},"required":["createdAt","updatedAt","id","title"]},"CreateSourcingLocationGroupDto":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"metadata":{"type":"object"}},"required":["title"]},"UpdateSourcingLocationGroupDto":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"metadata":{"type":"object"}}},"Task":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"user":{"$ref":"#/components/schemas/User"},"status":{"type":"string"},"message":{"type":"string"},"data":{"type":"object"},"logs":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}},"dismissedBy":{"type":"string"}},"required":["createdAt","updatedAt","id","type","user","status","data","logs","errors","dismissedBy"]},"CreateTaskDto":{"type":"object","properties":{"type":{"type":"string"},"status":{"type":"string"},"data":{"type":"object"}},"required":["type","status","data"]},"UpdateTaskDto":{"type":"object","properties":{"status":{"type":"string"},"newData":{"type":"object"},"dismissedBy":{"type":"string"}}},"IndicatorCoefficient":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"value":{"type":"number"},"year":{"type":"number"},"adminRegion":{"$ref":"#/components/schemas/AdminRegion"},"user":{"$ref":"#/components/schemas/User"},"indicator":{"$ref":"#/components/schemas/Indicator"},"material":{"$ref":"#/components/schemas/Material"}},"required":["createdAt","updatedAt","id","year","user","indicator","material"]},"CreateIndicatorCoefficientDto":{"type":"object","properties":{"value":{"type":"number"},"year":{"type":"number"}},"required":["year"]},"UpdateIndicatorCoefficientDto":{"type":"object","properties":{"value":{"type":"number"},"year":{"type":"number"}}},"Target":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"id":{"type":"string"},"baseLineYear":{"type":"number"},"targetYear":{"type":"number"},"value":{"type":"number"},"indicatorId":{"type":"string"},"updatedById":{"type":"string"}},"required":["createdAt","updatedAt","id","baseLineYear","targetYear","value","indicatorId","updatedById"]},"CreateTargetDto":{"type":"object","properties":{"baseLineYear":{"type":"number"},"targetYear":{"type":"number"},"value":{"type":"number"},"indicatorId":{"type":"string"}},"required":["baseLineYear","targetYear","value","indicatorId"]},"UpdateTargetDto":{"type":"object","properties":{"targetYear":{"type":"number"},"value":{"type":"number"}},"required":["targetYear","value"]},"Unit":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"symbol":{"type":"string"},"description":{"type":"number"}},"required":["id","name","symbol"]},"CreateUnitDto":{"type":"object","properties":{"name":{"type":"string"},"symbol":{"type":"string"},"description":{"type":"string"}},"required":["name"]},"UpdateUnitDto":{"type":"object","properties":{"name":{"type":"string"},"symbol":{"type":"string"},"description":{"type":"string"}}},"UrlResponseAttributes":{"type":"object","properties":{"params":{"type":"object"}},"required":["params"]},"UrlResponseDto":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/UrlResponseAttributes"}},"required":["type","id","attributes"]},"SerializedUrlResponseDto":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/UrlResponseDto"}},"required":["data"]},"DateValue":{"type":"object","properties":{"value":{"type":"object"}},"required":["value"]},"EUDRAlertDates":{"type":"object","properties":{"alertDate":{"$ref":"#/components/schemas/DateValue"}},"required":["alertDate"]},"FeatureClass":{"type":"object","properties":{"geometry":{"type":"object"},"properties":{"type":"object"},"type":{"type":"string"}},"required":["geometry","properties","type"]},"GeoFeatureResponse":{"type":"object","properties":{"geojson":{"$ref":"#/components/schemas/FeatureClass"}},"required":["geojson"]},"FeatureCollectionClass":{"type":"object","properties":{"features":{"type":"array","items":{"type":"string"}},"type":{"type":"string"}},"required":["features","type"]},"GeoFeatureCollectionResponse":{"type":"object","properties":{"geojson":{"$ref":"#/components/schemas/FeatureCollectionClass"}},"required":["geojson"]}}}}