POST /api/public/objective/
Create one or more objectives.
Servers
- https://my.15five.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
[] |
Array | Yes | |
[].is_progress_aligned |
Boolean | No |
Allow a child objective's progress to impact any aligned parent objectives |
[].parent_id |
Integer | No |
Objective's parent objective id |
[].description |
String | Yes |
Objective's description |
[].viewable_by_users[] |
Array | No |
List of user ids who can view objective |
[].key_results[] |
Array | No | |
[].key_results[].description |
String | Yes |
Key result's description |
[].key_results[].type |
String | No |
Type of key result Possible values:
Default value: "percent" |
[].key_results[].start_value |
Number | No |
Start value |
[].key_results[].currency |
String | No |
Currency if key result type is "currency" Default value: "USD" |
[].key_results[].owner_id |
Integer | No |
Owner user's ID |
[].key_results[].target_value |
Number | No |
Target value |
[].scope |
String | Yes |
Objective's scope Possible values:
|
[].start_ts |
String | Yes |
Objective's start date |
[].end_ts |
String | Yes |
Objective's end date |
[].visibility |
String | No |
Objective's visibility Possible values:
Default value: "public" |
[].viewable_by_groups[] |
Array | No |
List of group ids who can view objective |
[].tags[] |
Array | No |
List of tags |
[].user_id |
Integer | Yes |
Objective's owner id |
[].group_id |
Integer | No |
Associated group id |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.