Profit.co's Public API Documentation
OKR Create(With initiative)
POST https://api.profit.co/app/dao/v6/objective?a=save&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>
Body
PARAM
| Key | Datatype | Required | Description |
a
|
string | action type | |
apiKey
|
string | Required: API key of your Profit.co Account | |
accessKey
|
string | Required: Access key of your Profit.co Account |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status
Curl
curl -X POST 'https://api.profit.co/app/dao/v6/objective?a=save&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>?a=save&apiKey=<API_KEY>&accessKey=<ACCESS_KEY>' -F '{"name"=>"objectiveIds", "value"=>"[]", "datatype"=>"string"}=' -F '{"name"=>"sharedObjectiveIds", "value"=>"[]", "datatype"=>"string"}=' -F '{"name"=>"addedOkrs", "value"=>"[]", "datatype"=>"string"}=' -F '{"name"=>"removedOkrs", "value"=>"[]", "datatype"=>"string"}=' -F '{"name"=>"ownerTypeId", "value"=>"<OWNER_TYPE_ID>", "datatype"=>"string"}=' -F '{"name"=>"ownerId", "value"=>"<OWNER_ID>", "datatype"=>"string"}=' -F '{"name"=>"isAddAsKr", "value"=>"Y", "datatype"=>"string"}=' -F '{"name"=>"objectiveData", "value"=>"{\"ownerId\":2096509,\"ownerTypeId\":8,\"visibilities\":[{\"id\":1,\"lookupCode\":\"PUBLIC\",\"meaning\":\"All Employees\",\"description\":\"All Employees can see this OKR\",\"isEnabled\":\"Y\",\"isActive\":\"Y\",\"otis\":[91,49,8],\"visibilityImg\":\"/static/profit/P1.22.50/app/ng/src/assets/images/public.png\",\"formattedName\":\"All Employees\",\"isSelected\":false,\"visibilityId\":1,\"visibilityName\":\"All Employees\"}],\"periodId\":21,\"periodType\":\"QUARTER\",\"targetStartDate\":\"01/07/2021\",\"targetEndDate\":\"30/09/2021\",\"periodName\":\"Q3-2021\",\"selectedItems\":[1],\"selectedPeriodMonth\":\"Q3-2021\",\"customAttributes\":[{\"customAttributeId\":\"IN_1\",\"customAttributeValue\":\"Test\",\"customAttributeType\":\"input\",\"customAttributeTagName\":\"input_1618287314230\",\"customAttributeName\":\"input_1618287314230\",\"attributeValues\":[],\"input_1618287314230\":\"Test\",\"fieldType\":\"NUMBER\"}],\"shareOkrs\":[],\"sharedEmployees\":[],\"keyResultsIdx\":[],\"objectiveName\":\"Initiative Based OKR\",\"initiative\":{\"initiativeId\":14257,\"initiativeNo\":\"12\",\"name\":\"Establish operating framework for integrated energy model.\",\"strategicPlanYear\":2021,\"assignedToObjectRefId\":2100697,\"assignedToObjectRefName\":\"user 2\",\"departmentId\":2254074,\"departmentName\":\"D1\",\"statusId\":1,\"statusName\":\"Not Started\",\"focusAreaName\":\"new focus\",\"focusAreaId\":13481,\"measurements\":[{\"measurementId\":13223,\"name\":\"AST measurements\",\"version\":0}],\"initiativePlannedFrom\":\"01/09/2021\",\"initiativePlannedTo\":\"31/12/2021\",\"milestones\":[{\"milestoneId\":14379,\"milestoneNo\":\"1\",\"name\":\"Kicked Off\",\"description\":\"<p id=\\\"tinyEle\\\">Kicked Off</p>\",\"budgetAmount\":50000,\"targetMonth\":\"2021-09-01 00:00:00\",\"initiativeId\":14257,\"initiativeNo\":\"12\",\"wt\":25,\"cwt\":25,\"objectStatus\":\"0\",\"firmId\":254137,\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"createdByName\":\"Gcp Test\",\"creationDate\":\"2021-09-07 03:40:59\",\"lastUpdateDate\":\"2021-09-07 03:40:59\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":0},{\"milestoneId\":14380,\"milestoneNo\":\"2\",\"name\":\"Requirement\",\"description\":\"<p id=\\\"tinyEle\\\">Requirement</p>\",\"budgetAmount\":50000,\"targetMonth\":\"2021-10-01 00:00:00\",\"initiativeId\":14257,\"initiativeNo\":\"12\",\"wt\":25,\"cwt\":50,\"objectStatus\":\"0\",\"firmId\":254137,\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"createdByName\":\"Gcp Test\",\"creationDate\":\"2021-09-07 03:40:59\",\"lastUpdateDate\":\"2021-09-07 03:40:59\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":0},{\"milestoneId\":14381,\"milestoneNo\":\"3\",\"name\":\"Design\",\"description\":\"<p id=\\\"tinyEle\\\">Design</p>\",\"budgetAmount\":50000,\"targetMonth\":\"2021-10-01 00:00:00\",\"initiativeId\":14257,\"initiativeNo\":\"12\",\"wt\":10,\"cwt\":60,\"objectStatus\":\"0\",\"firmId\":254137,\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"createdByName\":\"Gcp Test\",\"creationDate\":\"2021-09-07 03:40:59\",\"lastUpdateDate\":\"2021-09-07 03:40:59\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":0},{\"milestoneId\":14382,\"milestoneNo\":\"4\",\"name\":\"Development\",\"description\":\"<p id=\\\"tinyEle\\\">Development</p>\",\"budgetAmount\":150000,\"targetMonth\":\"2021-11-01 00:00:00\",\"initiativeId\":14257,\"initiativeNo\":\"12\",\"wt\":20,\"cwt\":80,\"objectStatus\":\"0\",\"firmId\":254137,\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"createdByName\":\"Gcp Test\",\"creationDate\":\"2021-09-07 03:40:59\",\"lastUpdateDate\":\"2021-09-07 03:40:59\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":0},{\"milestoneId\":14383,\"milestoneNo\":\"5\",\"name\":\"Release\",\"description\":\"<p id=\\\"tinyEle\\\">Release</p>\",\"budgetAmount\":100000,\"targetMonth\":\"2021-12-01 00:00:00\",\"initiativeId\":14257,\"initiativeNo\":\"12\",\"wt\":20,\"cwt\":100,\"objectStatus\":\"0\",\"firmId\":254137,\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"createdByName\":\"Gcp Test\",\"creationDate\":\"2021-09-07 03:40:59\",\"lastUpdateDate\":\"2021-09-07 03:40:59\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":0}],\"initiativeCategoryId\":2,\"initiativeCategoryName\":\"new one categories\",\"budgetAmount\":400000,\"noOfMonths\":4,\"averageMonthlyProgess\":25,\"currentMonthProgress\":0,\"progressStatus\":\"Not Started\",\"wi\":10000,\"wn\":\"wave 1\",\"objectStatus\":\"0\",\"ob\":10010,\"firmId\":254137,\"customAttributes\":[],\"createdBy\":2084198,\"lastUpdatedBy\":2084198,\"createdByName\":\"Gcp Test\",\"creationDate\":\"2021-09-07 03:30:04\",\"lastUpdateDate\":\"2021-09-07 03:40:59\",\"lastUpdatedByName\":\"Gcp Test\",\"version\":1,\"sortNumber\":\"000000000000000000000000000000000000000000000000000000000012\"},\"initiativeName\":\"Establish operating framework for integrated energy model.\",\"delegateOkrs\":[],\"delegationTypeName\":null,\"delegationTypeId\":null,\"kwe\":\"N\",\"objectiveStatusName\":\"Not Started\",\"objectiveStatusId\":5,\"initiativeId\":14257,\"initiativeNo\":\"12\",\"ocn\":\"Strategic Initiative\",\"oci\":1,\"wn\":\"wave 1\",\"wi\":10000,\"mn\":\"Kicked Off\",\"mi\":14379,\"ato\":[]}", "datatype"=>"string"}=' -F '{"name"=>"taggedObjectRefIds", "value"=>"[]", "datatype"=>"string"}='
ENDPOINTS