Below is the data for objective depending on whether the objective is assigned to an individual, department or the whole company will change whether assignedPersonId, departmentId, or no Id is present, respectively. If objective is linked to other department or company objectives an objective summary will be present on this response in either the linkedDepartmentObjective or linkedCompanyObjective properties.
|
Objective Template |
{ "id": <int>, "templateId": <int – Not present if no template used>, "managerPersonId": <int>, "assignedPersonId": <int>, "departmentId": <int>, "linkedDepartmentObjective": <objectiveSummary>, "companyObjectiveId": <int>, "linkedCompanyObjective": <objectiveSummary >, "title": <string>, "description": <string>, "type": <int>, "valueType": <string>, "tag":<string>, "category": <string>, "startDate": <string ISO 8601 Date> "endDate": <string ISO 8601 Date>, "closed": <bool>, "contentSettings": <contentSettings see 8.0>, "notificationSettings" : <notificationSettings see 8.0>, "comments": [<comment – see 7.4>], "linkedDocumentIds": [<int>], "createdAt": <string ISO 8601 Date>, "createdByPersonId": <int>, "modifiedAt": <string ISO 8601 Date> "modifiedByPersonId": <int>, "currentProgress": <decimal>, "startValue":<decimal>, "targetValue": <decimal> } |
|
Objective Summary Template |
{ "id": <int>, "title": <string>, "summary": <string>, "category": <string>, } |
Json Schema (for use with MS Power Automate)
{
"type": "object",
"properties": {
"subjectType": {
"type": "string"
},
"changeType": {
"type": "string"
},
"subjectFrontEndUrl": {
"type": "string"
},
"timeStamp": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"templateId": {
"type": "integer"
},
"manager": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"person": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"teamId": {
"type": "integer"
},
"departmentId": {
"type": "integer"
},
"linkedDepartmentObjective": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"category": {
"type": "string"
}
}
},
"companyObjectiveId": {
"type": "integer"
},
"linkedCompanyObjective": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
},
"category": {
"type": "string"
}
}
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"summary": {
"type": "string"
},
"type": {
"type": "string"
},
"valueType": {
"type": "string"
},
"tag": {
"type": "string"
},
"category": {
"type": "string"
},
"ratingDetailsDto": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"category": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"valueType": {
"type": "integer"
},
"weighting": {
"type": "integer"
},
"scores": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"threshold": {
"type": "integer"
},
"isDeleted": {
"type": "boolean"
}
},
"required": [
"id",
"title",
"description",
"threshold",
"isDeleted"
]
}
},
"isDeleted": {
"type": "boolean"
}
}
},
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"lastProgressDate": {
"type": "string"
},
"closed": {
"type": "boolean"
},
"closedReason": {
"type": "string"
},
"allowAddProgress": {
"type": "boolean"
},
"notificationSettings": {
"type": "object",
"properties": {
"push": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"email": {
"type": "boolean"
},
"microsoftTeams": {
"type": "boolean"
},
"inApp": {
"type": "boolean"
}
}
},
"contentSettings": {
"type": "object",
"properties": {
"allowLikes": {
"type": "boolean"
},
"allowComments": {
"type": "boolean"
},
"allowImagesInComments": {
"type": "boolean"
},
"allowDocuments": {
"type": "boolean"
}
}
},
"comments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"relatedItemId": {
"type": "integer"
},
"itemType": {
"type": "string"
},
"comment": {
"type": "string"
},
"parentCommentId": {
"type": "integer"
},
"attachedDocumentIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"likesPersonIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdAt": {
"type": "string"
},
"createdByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"modifiedAt": {
"type": "string"
},
"modifiedByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
}
},
"required": [
"id",
"relatedItemId",
"itemType",
"comment",
"parentCommentId",
"attachedDocumentIds",
"likesPersonIds",
"createdAt",
"createdByPerson",
"modifiedAt",
"modifiedByPerson"
]
}
},
"linkedDocumentIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdAt": {
"type": "string"
},
"createdByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"modifiedAt": {
"type": "string"
},
"modifiedByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"currentProgress": {
"type": "integer"
},
"recurInterval": {
"type": "string"
},
"startValue": {
"type": "integer"
},
"targetValue": {
"type": "integer"
},
"isDeleted": {
"type": "boolean"
}
}
},
"differences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"oldValue": {
"type": "string"
},
"newValue": {
"type": "string"
}
},
"required": [
"path",
"oldValue",
"newValue"
]
}
}
}
}