Data Exchange Formats

Highlights to JSON

This reference describes the JSON returned by Squore when exporting data from highlights.

 {
 	"context":{
 		"artefact": {     Not available at model level
 			"name": string,
 			"path": string,
 			"id": int,
 			"type": {
 				"name": string,
 				"externalId": string,
 				"id": int
 			},
 			"url": string,
 			"version": {
 				"name": string,
 				"id": int
 			},
 			"project": {
 				"name": string,
 				"id": int
 			},
 		},
 		"model": {
 			"name": string,
 			"externalId": string,
 			"id": int
 		}
 	}
 	"highlights": [
 		{
 			"name": string,
 			"columns": [
 				{
 					"externalId":string,
 					"name": string,
 					"description": string,
 					"suffix": string,
 					"format": number|percent|man_days|man_hours|man_minutes|man_seconds|man_milliseconds|days|hours|minutes|seconds|milliseconds|integer|date|time|datetime,
 					"kind": metric|information|indicator,
 				},
 				...
 			],
 			"artefacts": [
 				{
 					"name": string,
 					"path": string,
 					"id": int,
 					"type": {
 						"name": string,
 						"externalId": string,
 						"id": int
 					}
 					"url": string,
 					"values":[
 						{
 							"value": string,
 							"formatted": string,
 							"bgColor": [int, int, int, int],  0-255
 						},
 						...
 					]
 				},
 				...
 			]
 		},
 		...
 	]
 }