Kronoscope APIs are broadly classified as:
\nAuthentication API
This API is meant to fetch the auth token to be used in all other APIs.
Forecast Data API
This API is meant to retrieve predicted forecasts from Kronoscope at any level you want to plan for.
Plans Data API
This API fetches the purchase or replenishment plans which were frozen in Kronoscope. The plans created consider all the constraints provided to us by the client. All the information needed to reconcile the final order quantites are provided in the response.
Data Integration API
This API is used for raw data ingestion into Kronoscope.
Order Management API
This API fetches purchase orders created and the receives tracked using Kronoscope.
user_name and password for the tool is required to use this API. Ask the customer success team if you don't already have it.
dataset_id and metric values are needed to use this API. Ask the customer success team if you don't already have it.
Required fields are in bold.
\nInteger
\n","type":"text/plain"},"key":"dataset_id","value":"(Optional) Default is \",\"
\n","type":"text/plain"},"key":"sep","value":"dataset_id value is needed to use this API. Ask the customer success team if you don't already have it.
If both created_date and updated_date are mentioned, then it is an AND operation.
Integer value
\n","type":"text/plain"},"key":"dataset_id","value":"(Optional) Plans with created_date greater than or equal to will be returned\nDate format: YYYY-MM-DD HH:MM:SS (UTC time)
\n","type":"text/plain"},"key":"created_date","value":"(Optional) Plans with updated_date greater than or equal to will be returned\nDate format: YYYY-MM-DD HH:MM:SS (UTC time)
\n","type":"text/plain"},"key":"updated_date","value":"(Optional) Login username
\n","type":"text/plain"},"key":"user_name","value":"dataset_id value is needed to use this API. Ask the customer success team if you don't already have it.
Fields in response when plan_type = \"Purchase Plan\"
\nFields in response when plan_type = \"Replenishment Plan\"
\n","urlObject":{"protocol":"https","path":["atlas","timeseries","api","get_plans_data"],"host":["acme","kronoscope","fountain9","com"],"query":[{"description":{"content":"Integer
\n","type":"text/plain"},"key":"dataset_id","value":"String
\n","type":"text/plain"},"key":"plan_id","value":"String
\n","type":"text/plain"},"key":"plan_type","value":"(Optional) Default is \",\"
\n","type":"text/plain"},"key":"sep","value":"The following is the structure of the request JSON.
\n{\n\"payload\": {}\n}\n\nThe following are the fields that are needed:
\nInteger
\n","type":"text/plain"},"key":"dataset_id","value":"Request body should contain filters for the rows that need to be read.
\nThe following is the structure of the request JSON.
\n{\n\"search_filter\": {}\n}\n\nThe following are the fields that can used to filter rows that need to be read:
\n","urlObject":{"protocol":"https","path":["atlas","data_integration","mapping","read"],"host":["acme","kronoscope","fountain9","com"],"query":[{"description":{"content":"Integer
\n","type":"text/plain"},"key":"dataset_id","value":"Request body should contain two fields, one for searching the rows that you want to update and second for updating the field and value in those rows.
\nThe following is the structure of the request JSON. search_filter is optional.
{\n\"search_filter\": {}, \n\"update_filter\": {}\n}\n\nThe following are the fields that can be updated:
\n","urlObject":{"protocol":"https","path":["atlas","data_integration","mapping","update"],"host":["acme","kronoscope","fountain9","com"],"query":[{"description":{"content":"Integer
\n","type":"text/plain"},"key":"dataset_id","value":"Request body should contain filters for the rows that need to be deleted. The filter cannot be empty.
\nThe following is the structure of the request JSON.
\n{\n\"delete_filter\": {}\n}\n\nThe following are the fields that can used to filter rows that need to be deleted:
\n","urlObject":{"protocol":"https","path":["atlas","data_integration","mapping","delete"],"host":["acme","kronoscope","fountain9","com"],"query":[{"description":{"content":"Integer
\n","type":"text/plain"},"key":"dataset_id","value":"Please make sure the mapping is created using Create Mapping API before ingesting data.
This request is requires you to specify two query parameters:dataset_id can be obtained from the customer success team
type indicates the type of dataset that needs to be ingested.
Possbile values for type field: sales, inventory, product_master, branch_master, purchase_orders, transfer_orders, supplier_master, raw_material_master, products_branches_suppliers, products_branches_warehouses, demand_drivers
The request body should be of form-data type and include a key payload with value as a csv file.
The csv file cannot have more than 250,000 rows. If data is larger than that, then break down the data and then send it using multiple API requests.
\nThe csv file should have the same fields as defined using the Create Mapping API else it will be rejected.
Python code snippet for reference:
\nimport requests\nimport json\nurl = 'https://acme.kronoscope.fountain9.com/atlas'\nresponse = requests.post(url + \"/auth/api/token?domain=acme.com\",\n json={\"user_name\": 'demo@acme.com', \"password\": 'password',\n \"is_superuser\": False})\nd = json.loads(response.text)\nheaders = {\"Authorization\": \"Bearer \" + d['access']}\ntest_file = open(r'/path/to/test_sales.csv', \"rb\")\nresponse = requests.post(url + \"/data_integration/data/create?dataset_id=1&type=sales\", files = {\"payload\": test_file}, headers=headers) \n\nInteger
\n","type":"text/plain"},"key":"dataset_id","value":"String
\n","type":"text/plain"},"key":"type","value":"This request is requires you to specify two query parameters:dataset_id can be obtained from the customer success team
type indicates the type of dataset that needs to be ingested.
Possbile values for type field: sales, inventory, product_master, branch_master, purchase_orders, transfer_orders, supplier_master, raw_material_master, products_branches_suppliers, products_branches_warehouses, external_variable
The following is the structure of the request JSON.
\n{\n\"search_filter\": {}\n}\n\nThe search_filter should have the same fields as defined using the Create Mapping API else it will be rejected.
Search operations supported in search_filter:
Integer
\n","type":"text/plain"},"key":"dataset_id","value":"String
\n","type":"text/plain"},"key":"type","value":"Request body should contain two fields, one for searching the rows that you want to update and second for updating the field and value in those rows.
\nUpdate is only allowed for the following datasets: product_master, branch_master, supplier_master, raw_material_master, products_branches_suppliers, products_branches_warehouses
\nThe following is the structure of the request JSON. search_filter is optional.
{\n\"search_filter\": {}, \n\"update_filter\": {}\n}\n\nSearch operations supported in search_filter:
Integer
\n","type":"text/plain"},"key":"dataset_id","value":"String
\n","type":"text/plain"},"key":"type","value":"Request body should contain filters for the rows that need to be deleted. The filter cannot be empty.
\nThe following is the structure of the request JSON.
\n{\n\"delete_filter\": {}\n}\n\nSearch operations supported in search_filter:
Integer
\n","type":"text/plain"},"key":"dataset_id","value":"String
\n","type":"text/plain"},"key":"type","value":"dataset_id value is needed to use this API. Ask the customer success team if you don't already have it.
Request field descriptions:
\nInteger
\n","type":"text/plain"},"key":"dataset_id","value":"dataset_id value is needed to use this API. Ask the customer success team if you don't already have it.
Request field descriptions:
\nInteger
\n","type":"text/plain"},"key":"dataset_id","value":"