A JSON Chart Update API can be used to update Charts — including their data — in KaiNexus.
REQUIRED: Your organization must have the API Module enabled to perform the actions mentioned in this article. Reach out to your Customer Success Manager if you're interested in this module.
A JSON Chart Update API call lets you update the information for many Charts simultaneously. This not only streamlines the process of updating Charts in the system but also helps you update information in KaiNexus based on information from other systems.
Some customers automatically feed chart data into KaiNexus via a Chart Update API from their manufacturing intelligence systems. These metrics automatically update on team boards to help show team members their progress toward their goals.
If you're looking for information on updating non-Chart Items in KaiNexus, check out this article about the JSON Item Update API.
How does it work?
KaiNexus provides an endpoint where you can access Chart information. To make a call, you will need an API Key and an API tool.
Pro Tip: We recommend using Postman for your API calls. It's easy to use and works well with KaiNexus API.
Authentication
API Keys are used for authenticating calls to KaiNexus API. Check out this article for instructions on how you can find your organization's API Keys and copy them to your clipboard.
If you are using Postman, select Basic Auth as the Authorization Type.
- Enter "api" as the username.
- Enter the API Key as the password.
Make sure your API Key has been granted the necessary permission to "view" and edit any Charts you want to update. For an API to be able to edit all Charts in KaiNexus, the View, View New, View Private, and Edit permissions need to be granted and set to "Everywhere" for all Workflows. Check out this support article for more information on each of these permissions.
Sending Requests
After authentication, you can make your first JSON Chart Update API call. We recommend starting with a GET request to retrieve a list of Charts in proper JSON format. This will be useful as a reference for the correct JSON format when updating Charts.
To update an individual Chart, make a PUT request to this URL:
https://api.kainexus.com/api/public/v1/json/item?fullSync=true
- The addition of "fullSync=true" will allow you to fully update a Chart's data, including its dates, categories, annotations, etc.
To update multiple Charts, make a PUT request to this URL:
https://api.kainexus.com/api/public/v1/json/itemList?fullSync=true
- The addition of "fullSync=true" will allow you to fully update a Chart's data, including its dates, categories, annotations, etc.
If an ID is provided, the existing Chart with that ID will be updated. If no ID is provided, a new Chart will be created if all required information is provided.
To learn about creating new Items with a JSON Item Creation API, check out this support article. To learn about updating existing Items with a JSON Chart Update API, check out this support article instead.
Updating the Chart Item
Like the JSON Item Update API, the JSON Chart Update API can be used to update Item details, such as Status, Fields, Attributes, Team, and more.
If you are updating the Chart's Status, refer to the table below to ensure all required fields are included for each Status. These represent the default requirements; however, your organization's Template configuration may differ.
| Status | User Fields | Date Fields |
| DRAFT |
|
|
| NEW |
|
|
| PLANNED |
|
|
| ACTIVE |
|
|
| RES_SUBMITTED |
|
|
| COMPLETE |
|
|
| DEFERRED |
|
|
NOTE: Existing Charts can not be transitioned back into the Draft status.
Updating Chart Data
The JSON Chart Update API allows you to add new data points to your Chart or update existing ones. To successfully add or update data points, your request must include the Chart Item's ID, the Data Series ID, and the date, category, and value of the data point.
Update or add a data point
Here is an example of JSON that will update a data point on a chart:
{
"item": {
"id": 2624,
"chart": {
"series": [
{
"id": 409,
"dataPoints": [
{
"id": 12885,
"date": "2024-12-08T06:00:00.000+0000",
"category": "",
"value": 145.0
}
]
}
]
}
}
}
- Within a data series, you can identify an individual data point by its ID, date or category.
- The system will first look at the ID and update that data point to the entered date, category, and value.
- If you do not provide an ID for the data point, the system will check if there is an existing data point matching the provided date or category. If so, it will update that data point to your entered value.
- If you do not provide an ID and there is no existing data point matching the provided date or category, the API will add a new data point to the Chart.
Add or update an Annotation
Here is an example of JSON that will add a new annotation to a data point:
{
"item": {
"id": 2624,
"chart": {
"series": [
{
"id": 409,
"dataPoints": [
{
"date": "2024-12-08T06:00:00.000+0000",
"category": "",
"value": 145,
"annotations": [
{
"note": "6 team members were on PTO this day."
}
]
}
]
}
]
}
}
}
If you want to update an existing annotation, you must reference the annotation's ID, which can be found by exporting the Chart to JSON.
{
"item": {
"id": 2624,
"chart": {
"series": [
{
"id": 409,
"dataPoints": [
{
"date": "2024-12-08T06:00:00.000+0000",
"category": "",
"value": 145,
"annotations": [
{
"id": 246,
"note": "7 team members were on PTO this day."
}
]
}
]
}
]
}
}
}
/Ofie/Ofie%20Profile%20Pic.png?width=50&height=50&name=Ofie%20Profile%20Pic.png)
Important: If you do not need to update or add annotations to your Chart, you should exclude them from your import file so you do not accidentally add new annotations. Furthermore, referencing an annotation by its ID without updating the value of the Annotation will result in an error.
Limitations
What data on a Chart cannot be updated through the JSON API?
- You cannot create a new data series. You can only update data for existing series.
- You cannot use the API to create a new Chart with pre-populated data. You can create the new Item through the JSON Item Creation API, but you cannot add data to the Chart until you manually create the data series in the platform.
- You cannot remove a data row from a Chart. You can only add or update them.
- You cannot remove Chart annotations. You can only add or update them.
Helpful Tips
- By default, anyone who would be notified of updates made to a Chart within KaiNexus will also be notified about changes made to the Chart with the Chart Update API.
- To suppress these notifications for a Chart included in your import, add the following line to that Chart's code segment.
"suppressNotifications": true
This line must be added for each Chart for which notification should be suppressed.
- To suppress these notifications for a Chart included in your import, add the following line to that Chart's code segment.
- The Chart(s) being updated must be referenced by ID.
- You can find a Chart's ID to the right of its title when looking at the Chart's work panel — unless it has been hidden by the Template's configuration — or by adding an ID column to an Item List in List, Tree, or Gantt View.
- Fields, Attributes, and Attribute Values can be referenced by name or ID.
- To update an Attribute that belongs to a Weighted Score, the name or ID of the Weighted Score must be provided.
- A note can be included on Attribute Values that support notes.
- Fields require a key to their value dependent on the Field's type.
- 'dateValue' for date fields.
- 'numericValue' for number fields.
- 'value' for text fields.
- Milestone Approver system Roles will be taken into account when using an API Key. Meaning, if your API Key does not have the same Role(s) as the one(s) listed as the only acceptable Approver(s) then this could result in a permissions error.
- All dates — both Item dates and dates in the Chart's data — utilize ISO 8601 format. Example: "2019-04-29T16:30:40.000+0000"
- The KaiNexus API enforces rate limits to ensure system stability. We recommend limiting your rate of API calls to no more than 5 calls per minute. However, there is no rate limit if you are updating one Chart at a time.
Import Examples
Example: Curl Script for importing a list of Charts
curl -s -D - --user api:APIKEY https://api.kainexus.com/api/public/v1/json/itemUpdate -d @FILEPATH
-
Replace APIKEY with the API Key generated in KaiNexus
-
The file must be UTF-8 encoded.
Example: JSON Format for importing a list of Charts
{
"items": [
{
"templateId": 40,
"templateName": "Chart",
"id": 7942,
"summary": "Environmental Impact",
"parentId": 6422,
"chart": {
"id": 1795,
"useDate": true,
"chartState": "TERTIARY_MET",
"chartType": "THRESHOLD",
"series": [
{
"id": 5994,
"name": "Threshold",
"format": "AUTOMATIC",
"type": "THRESHOLD_PRIMARY",
"dataPoints": [
{
"id": 51309,
"value": 1000.0,
"date": "2022-08-01T04:00:00.000+0000",
"category": "Category A",
"annotations": []
},
{
"id": 51310,
"value": 1000.0,
"date": "2022-08-02T04:00:00.000+0000",
"category": "Category B",
"annotations": []
},
{
"id": 51308,
"value": 1000.0,
"date": "2022-08-03T04:00:00.000+0000",
"category": "Category C",
"annotations": []
},
{
"id": 51306,
"value": 1000.0,
"date": "2022-08-04T04:00:00.000+0000",
"category": "Category D",
"annotations": []
},
{
"id": 51307,
"value": 1000.0,
"date": "2022-08-05T04:00:00.000+0000",
"category": "Category E",
"annotations": []
}
]
},
{
"id": 5996,
"name": "Threshold -THRESHOLD_SECONDARY-",
"format": "AUTOMATIC",
"type": "THRESHOLD_SECONDARY",
"dataPoints": [
{
"id": 51319,
"value": 800.0,
"date": "2022-08-01T04:00:00.000+0000",
"category": "Category A",
"annotations": []
},
{
"id": 51320,
"value": 800.0,
"date": "2022-08-02T04:00:00.000+0000",
"category": "Category B",
"annotations": []
},
{
"id": 51316,
"value": 800.0,
"date": "2022-08-03T04:00:00.000+0000",
"category": "Category C",
"annotations": []
},
{
"id": 51317,
"value": 800.0,
"date": "2022-08-04T04:00:00.000+0000",
"category": "Category D",
"annotations": []
},
{
"id": 51318,
"value": 800.0,
"date": "2022-08-05T04:00:00.000+0000",
"category": "Category E",
"annotations": []
}
]
},
{
"id": 5997,
"name": "Threshold -THRESHOLD_TERTIARY-",
"format": "AUTOMATIC",
"type": "THRESHOLD_TERTIARY",
"dataPoints": [
{
"id": 51323,
"value": 500.0,
"date": "2022-08-01T04:00:00.000+0000",
"category": "Category A",
"annotations": []
},
{
"id": 51322,
"value": 500.0,
"date": "2022-08-02T04:00:00.000+0000",
"category": "Category B",
"annotations": []
},
{
"id": 51321,
"value": 500.0,
"date": "2022-08-03T04:00:00.000+0000",
"category": "Category C",
"annotations": []
},
{
"id": 51324,
"value": 500.0,
"date": "2022-08-04T04:00:00.000+0000",
"category": "Category D",
"annotations": []
},
{
"id": 51325,
"value": 500.0,
"date": "2022-08-05T04:00:00.000+0000",
"category": "Category E",
"annotations": []
}
]
},
{
"id": 5998,
"name": "Threshold -THRESHOLD_BASELINE-",
"format": "AUTOMATIC",
"type": "THRESHOLD_BASELINE",
"dataPoints": [
{
"id": 51328,
"value": 200.0,
"date": "2022-08-01T04:00:00.000+0000",
"category": "Category A",
"annotations": []
},
{
"id": 51330,
"value": 200.0,
"date": "2022-08-02T04:00:00.000+0000",
"category": "Category B",
"annotations": []
},
{
"id": 51326,
"value": 200.0,
"date": "2022-08-03T04:00:00.000+0000",
"category": "Category C",
"annotations": []
},
{
"id": 51329,
"value": 200.0,
"date": "2022-08-04T04:00:00.000+0000",
"category": "Category D",
"annotations": []
},
{
"id": 51327,
"value": 200.0,
"date": "2022-08-05T04:00:00.000+0000",
"category": "Category E",
"annotations": []
}
]
},
{
"id": 5995,
"name": "Data",
"format": "AUTOMATIC",
"type": "BAR",
"dataPoints": [
{
"id": 51312,
"value": 1500.0,
"date": "2022-08-01T04:00:00.000+0000",
"category": "Category A",
"annotations": []
},
{
"id": 51315,
"value": 900.0,
"date": "2022-08-02T04:00:00.000+0000",
"category": "Category B",
"annotations": []
},
{
"id": 51311,
"value": 600.0,
"date": "2022-08-03T04:00:00.000+0000",
"category": "Category C",
"annotations": []
},
{
"id": 51313,
"value": 400.0,
"date": "2022-08-04T04:00:00.000+0000",
"category": "Category D",
"annotations": []
},
{
"id": 51314,
"value": 700.0,
"date": "2022-08-05T04:00:00.000+0000",
"category": "Category E",
"annotations": []
}
]
}
]
},
"status": "DEFERRED",
"chartType": "THRESHOLD",
"fields": [],
"attributes": [
{
"id": 1,
"name": "Priority",
"values": [
{
"id": 17,
"name": "Medium (=50)"
}
]
},
{
"id": 3,
"name": "Strategic Initiative",
"values": [
{
"id": 27,
"name": "Quality",
"note": "",
"htmlNote": ""
},
{
"id": 25,
"name": "Mission and Culture"
}
]
}
],
"milestones": [
{
"id": 7,
"name": "Adjust",
"status": "NOT_READY"
}
],
"authors": [
{
"id": 27,
"username": "blanche",
"firstName": "Blanche",
"lastName": "Watson",
"email": ""
},
{
"id": 4,
"username": "greg",
"firstName": "Greg",
"lastName": "Jacobson",
},
{
"id": 15,
"username": "ryan",
"firstName": "Ryan",
"lastName": "Confer",
"email": ""
}
],
"participatingLocations": [],
"originatingLocations": [],
"responsibleLocations": [
{
"id": 20,
},
{
"id": 4,
},
{
"id": 1,
},
{
"id": 19,
},
{
"id": 3,
}
],
"createDate": "2022-07-27T15:37:17.000+0000",
"reviewDate": "2025-07-26T04:00:00.000+0000",
"lastUpdateDate": "2022-09-05T16:57:34.000+0000",
"likeCount": 0,
"ackCount": 0,
"voteCount": 0,
"downstreamDependencies": [
{
"id": 7943
}
],
"weightedScores": [
{
"scoreId": 19,
"scoreName": "Impact",
"score": 0.0
}
],
"private": false
},
{
"templateId": 40,
"templateName": "Chart",
"id": 7591,
"summary": "Mechanisms",
"parentId": 4888,
"parentSummary": "Mobile app updates",
"chart": {
"id": 1676,
"useDate": true,
"chartType": "CONTROL",
"series": [
{
"id": 5415,
"name": "#",
"format": "#,###.00",
"type": "LINE",
"dataPoints": [
{
"id": 46680,
"value": 10000002.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46681,
"value": 2522232.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46679,
"value": 2655.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46678,
"value": 3443775.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46682,
"value": 2976345.54678,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46693,
"value": 3234564.4538378,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5419,
"name": "A",
"format": "AUTOMATIC",
"type": "LINE",
"dataPoints": [
{
"id": 46705,
"value": 7537537.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46700,
"value": 5785634.7545345,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46701,
"value": 4727878.37387,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46704,
"value": 7837837.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46702,
"value": 3243557.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46703,
"value": 3753783.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5420,
"name": "$",
"format": "$#,###.##",
"type": "LINE",
"dataPoints": [
{
"id": 46708,
"value": 2785378.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46707,
"value": 375375.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46710,
"value": 3537377.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46711,
"value": 4341237.57543,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46709,
"value": 3243753.75367583,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46706,
"value": 7735753.45375343,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5421,
"name": "%",
"format": "##.###%",
"type": "LINE",
"dataPoints": [
{
"id": 46712,
"value": 100.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46717,
"value": 56.4753453,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46715,
"value": 45.45645,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46716,
"value": 33.7537537,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46713,
"value": 86.4537537,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46714,
"value": 92.45375,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5436,
"name": "Threshold",
"format": "#,###.##",
"type": "THRESHOLD_PRIMARY",
"dataPoints": [
{
"id": 46802,
"value": 13345.453453,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46803,
"value": 13345.453453,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46806,
"value": 13345.453453,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46805,
"value": 13345.453453,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46804,
"value": 13345.453453,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46807,
"value": 13345.453453,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5437,
"name": "Threshold -THRESHOLD_BASELINE-",
"format": "#,###.##",
"type": "THRESHOLD_BASELINE",
"dataPoints": [
{
"id": 46810,
"value": 12345.45345345,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46813,
"value": 12345.45345345,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46812,
"value": 12345.45345345,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46808,
"value": 12345.45345345,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46809,
"value": 12345.45345345,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46811,
"value": 12345.45345345,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5458,
"name": "Control",
"format": "#,###.00",
"type": "THRESHOLD_PRIMARY",
"dataPoints": [
{
"id": 46937,
"value": 13453.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46936,
"value": 13453.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46935,
"value": 13453.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46934,
"value": 13453.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46938,
"value": 13453.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46939,
"value": 13453.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5459,
"name": "Control -THRESHOLD_SECONDARY-",
"format": "#,###.00",
"type": "THRESHOLD_SECONDARY",
"dataPoints": [
{
"id": 46945,
"value": 12412.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46942,
"value": 12412.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46943,
"value": 12412.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46941,
"value": 12412.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46940,
"value": 12412.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46944,
"value": 12412.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5460,
"name": "Control -THRESHOLD_TERTIARY-",
"format": "#,###.00",
"type": "THRESHOLD_TERTIARY",
"dataPoints": [
{
"id": 46946,
"value": 12345.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46947,
"value": 12345.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46948,
"value": 12345.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46950,
"value": 12345.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46951,
"value": 12345.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46949,
"value": 12345.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5488,
"name": "Test",
"format": "$#,###.00",
"type": "THRESHOLD_PRIMARY",
"dataPoints": [
{
"id": 47118,
"value": 1000.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47116,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47115,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47114,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47119,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47117,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5489,
"name": "Test -THRESHOLD_SECONDARY-",
"format": "$#,###.00",
"type": "THRESHOLD_SECONDARY",
"dataPoints": [
{
"id": 47120,
"value": 100.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47122,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47125,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47123,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47121,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47124,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
}
]
},
"status": "NEW",
"chartType": "CONTROL,
"fields": [],
"attributes": [],
"milestones": [
{
"id": 7,
"name": "Adjust",
"status": "NOT_READY"
}
],
"authors": [
{
"id": 4
}
],
"participatingLocations": [],
"originatingLocations": [
{
"id": 19
},
{
"id": 20
},
{
"id": 21
},
{
"id": 3
}
],
"responsibleLocations": [
{
"id": 19
},
{
"id": 20
},
{
"id": 21
},
{
"id": 3
}
],
"createDate": "2022-04-07T20:45:22.000+0000",
"lastUpdateDate": "2022-04-08T18:26:33.000+0000",
"likeCount": 0,
"ackCount": 0,
"voteCount": 0,
"private": false
}
]
}
Example: JSON Format for importing an individual Chart
{
"item": {
"templateId": 40,
"templateName": "Chart",
"id": 7591,
"summary": "Mechanisms",
"parentId": 4888,
"chart": {
"id": 1676,
"useDate": true,
"chartType": "CONTROL",
"series": [
{
"id": 5415,
"name": "#",
"format": "#,###.00",
"type": "LINE",
"dataPoints": [
{
"id": 46680,
"value": 10000000.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46681,
"value": 2522232.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46679,
"value": 2655.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46678,
"value": 3443775.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46682,
"value": 2976345.54678,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46693,
"value": 3234564.4538378,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5419,
"name": "A",
"format": "AUTOMATIC",
"type": "LINE",
"dataPoints": [
{
"id": 46705,
"value": 7537537.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46700,
"value": 5785634.7545345,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46701,
"value": 4727878.37387,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46704,
"value": 7837837.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46702,
"value": 3243557.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46703,
"value": 3753783.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5420,
"name": "$",
"format": "$#,###.##",
"type": "LINE",
"dataPoints": [
{
"id": 46708,
"value": 2785378.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46707,
"value": 375375.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46710,
"value": 3537377.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46711,
"value": 4341237.57543,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46709,
"value": 3243753.75367583,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46706,
"value": 7735753.45375343,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5421,
"name": "%",
"format": "##.###%",
"type": "LINE",
"dataPoints": [
{
"id": 46712,
"value": 100.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46717,
"value": 56.4753453,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46715,
"value": 45.45645,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46716,
"value": 33.7537537,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46713,
"value": 86.4537537,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46714,
"value": 92.45375,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5436,
"name": "Threshold",
"format": "#,###.##",
"type": "THRESHOLD_PRIMARY",
"dataPoints": [
{
"id": 46802,
"value": 13345.453453,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46803,
"value": 13345.453453,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46806,
"value": 13345.453453,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46805,
"value": 13345.453453,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46804,
"value": 13345.453453,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46807,
"value": 13345.453453,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5437,
"name": "Threshold -THRESHOLD_BASELINE-",
"format": "#,###.##",
"type": "THRESHOLD_BASELINE",
"dataPoints": [
{
"id": 46810,
"value": 12345.45345345,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46813,
"value": 12345.45345345,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46812,
"value": 12345.45345345,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46808,
"value": 12345.45345345,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46809,
"value": 12345.45345345,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46811,
"value": 12345.45345345,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5458,
"name": "Control",
"format": "#,###.00",
"type": "THRESHOLD_PRIMARY",
"dataPoints": [
{
"id": 46937,
"value": 13453.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46936,
"value": 13453.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46935,
"value": 13453.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46934,
"value": 13453.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46938,
"value": 13453.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46939,
"value": 13453.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5459,
"name": "Control -THRESHOLD_SECONDARY-",
"format": "#,###.00",
"type": "THRESHOLD_SECONDARY",
"dataPoints": [
{
"id": 46945,
"value": 12412.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46942,
"value": 12412.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46943,
"value": 12412.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46941,
"value": 12412.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46940,
"value": 12412.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46944,
"value": 12412.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5460,
"name": "Control -THRESHOLD_TERTIARY-",
"format": "#,###.00",
"type": "THRESHOLD_TERTIARY",
"dataPoints": [
{
"id": 46946,
"value": 12345.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46947,
"value": 12345.0,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46948,
"value": 12345.0,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46950,
"value": 12345.0,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46951,
"value": 12345.0,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 46949,
"value": 12345.0,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5488,
"name": "Test",
"format": "$#,###.00",
"type": "THRESHOLD_PRIMARY",
"dataPoints": [
{
"id": 47118,
"value": 1000.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47116,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47115,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47114,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47119,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47117,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
},
{
"id": 5489,
"name": "Test -THRESHOLD_SECONDARY-",
"format": "$#,###.00",
"type": "THRESHOLD_SECONDARY",
"dataPoints": [
{
"id": 47120,
"value": 50.0,
"date": "2022-04-07T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47122,
"date": "2022-04-08T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47125,
"date": "2022-04-09T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47123,
"date": "2022-04-10T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47121,
"date": "2022-04-11T04:00:00.000+0000",
"category": "",
"annotations": []
},
{
"id": 47124,
"date": "2022-04-12T04:00:00.000+0000",
"category": "",
"annotations": []
}
]
}
]
},
"status": "NEW",
"chartType": "BAR_LINE",
"fields": [],
"attributes": [],
"milestones": [
{
"id": 7,
"name": "Adjust",
"status": "NOT_READY"
}
],
"authors": [
{
"id": 4
}
],
"participatingLocations": [],
"originatingLocations": [
{
"id": 19
},
{
"id": 20
},
{
"id": 21
},
{
"id": 3
}
],
"responsibleLocations": [
{
"id": 19
},
{
"id": 20
},
{
"id": 21
},
{
"id": 3
}
],
"createDate": "2022-04-07T20:45:22.000+0000",
"lastUpdateDate": "2022-04-08T18:26:33.000+0000",
"likeCount": 0,
"ackCount": 0,
"voteCount": 0,
"private": false
}
}
Example: Comment submission
{
"item": {
"id": 6144,
"comments": [
{
"author": {
"username": "greg"
},
"comment": "This was submitted via API"
}
]
}
}
Example: Resolution Update with Actual, Target, Forecast, and Investment metrics
{
"item": {
"id": 12345,
"resolutionActual": {
"result": "CHANGE",
"impacts": [
{
"typeName": "Satisfaction",
"comment": "",
"pastCount": 10,
"pastUnit": "DAY",
"futureCount": 5,
"futureUnit": "DAY",
"decreasedChance": "YES",
"classification": "SIGNIFICANT"
},
{
"typeName": "Time Savings",
"comment": "Math",
"valueType": "RECURRING",
"amount": 5.0,
"amountTimeUnit": "HOUR",
"currencyCode": "USD",
"recurringInterval": "DAY",
"personProductServiceResource": "Engineer",
"numberOfPeople": 4.0
},
{
"typeName": "Revenue Generation",
"title": "Revenue Generation",
"comment": "Math",
"valueType": "RANGE",
"amount": 150.0,
"currencyCode": "USD",
"rangeStart": "2020-01-15T06:00:00.000+0000",
"rangeEnd": "2020-10-15T05:00:00.000+0000"
},
{
"typeName": "Quality Improvement"
},
{
"typeId": 3,
"typeName": "Satisfaction - Customer",
"locations": [
{
"id": 3,
"name": "Development"
},
{
"id": 1,
"name": "Executive"
}
],
"attributes": [
{
"id": 2,
"name": "Category",
"values": [
{
"id": 3629,
"name": "General Process"
}
]
}
]
},
{
"typeName": "Takt",
"comment": "Math",
"valueType": "ONE_TIME",
"amount": 5.0,
"amountTimeUnit": "HOUR",
"locations": [
{
"id": 1,
"name": "Executive"
}
]
},
{
"typeName": "Cost Savings",
"title": "Cost Savings",
"comment": "Math",
"valueType": "CUSTOM",
"currencyCode": "USD",
"monthlyValues": [
{
"year": 2020,
"month": 3,
"value": 200.0
},
{
"year": 2020,
"month": 1,
"value": 100.0
},
{
"year": 2020,
"month": 2,
"value": 500.0
},
{
"year": 2020,
"month": 4,
"value": 200.0
}
]
}
],
"investments": [
{
"typeId": 1469,
"typeName": "Financial",
"id": 253691,
"title": "Financial",
"comment": "Math",
"valueType": "ONE_TIME",
"amount": 1000.0,
"currencyCode": "USD",
"realizedDate": "2020-07-17T05:00:00.000+0000"
}
]
},
"resolutionTarget": {
"investments": [
{
"typeId": 1469,
"typeName": "Financial",
"id": 253697,
"title": "Cost Savings",
"comment": "Math",
"valueType": "RECURRING",
"amount": 1000.0,
"currencyCode": "USD",
"recurringInterval": "WEEK",
"realizedDate": "2020-07-17T18:32:01.000+0000"
}
]
},
"resolutionForecast": {
"investments": [
{
"typeId": 1469,
"typeName": "Financial",
"id": 253696,
"title": "Cost Savings",
"comment": "Math",
"valueType": "ONE_TIME",
"amount": 10000.0,
"currencyCode": "USD",
"realizedDate": "2020-07-17T18:31:52.000+0000",
"monthlyValues": [
{
"year": 2020,
"month": 7,
"value": 10000.0
}
]
}
]
}
}
}
Example: Updating Milestones
{
"item": {
"id": 12345,
"milestones": [
{
"name": "Committee Approval",
"status": "APPROVED",
"notes": "This looks great.",
"lastUpdatedBy": {
"username": "user12456"
}
},
{
"name": "Finance Approval",
"status": "NOT_APPROVED",
"notes": "We need a little more information.",
"lastUpdatedBy": {
"username": "user12456"
}
}
]
}
}
Error Codes
Failed updates will return an error containing a code and message that can be referenced below:
| Error Code | Explanation |
| UNKNOWN |
An UNKNOWN error could be due to one of the following:
|
| NOT_FOUND |
A NOT_FOUND error could be due to one of the following:
|
| NOT_VALID |
A NOT_VALID error could be due to one of the following:
|
| EMPTY | An EMPTY error could be due to one of the following:
|
| SIZE | A field exceeded its minimum or maximum size. |
| INVALID_CHANGE |
An INVALID_CHANGE error could be due to one of the following:
|
| ACCESS_DENIED |
An ACCESS_DENIED error could be due to one of the following:
|