CheckPoint
Checkpoint towards completion of an associated project. The most important fields are
name
, dueDate
, and project
. An example JSON representation looks like this:
{ "name" : "Code Freeze", "description" : "No check-ins after this point", "dueDate" : "2012-07-31T07:00:00.000+0000", "published" : "2012-07-30T22:42:38.525+0000", "updated" : "2012-07-30T22:42:38.525+0000", "id" : "1001", "project" : { "parent" : "https://example.jiveon.com/api/core/v3/places/1275", "type" : "project", "startDate" : "2012-07-30T07:00:00.000+0000", "dueDate" : "2015-07-16T06:59:59.999+0000", "creator" : { "name" : { "givenName" : "John", "familyName" : "Admin", "formatted" : "John Admin" }, "type" : "person", "displayName" : "John Admin", "id" : "1" }, "projectStatus" : "HIGH", "name" : "My project for checkpoints", "displayName" : "my-project-for-checkpoints", "description" : "", "status" : "Active", "contentTypes" : [ "blog", "projects", "discussions", "documents", "files", "polls", "tasks" ], "viewCount" : 3, "published" : "2012-07-30T22:39:32.608+0000", "updated" : "2012-07-30T22:42:38.524+0000", "visibleToExternalContributors" : false, "tags" : [ ], "followerCount" : 1, "resources" : { "checkpoints" : { "ref" : "https://example.jiveon.com/api/core/v3/checkpoints/13199", "allowed" : [ "POST", "GET" ] }, "contents" : { "ref" : "https://example.jiveon.com/api/core/v3/contents?filter=place(http%3A%2F%2FLT-WS-090156%3A8080%2Fapi%2Fcore%2Fv3%2Fplaces%2F13199)", "allowed" : [ "GET" ] }, "announcements" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199/announcements", "allowed" : [ "POST", "GET" ] }, "self" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199", "allowed" : [ "GET", "DELETE", "PUT" ] }, "html" : { "ref" : "https://example.jiveon.com/community/some_name/projects/my-project-for-checkpoints", "allowed" : [ "GET" ] }, "categories" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199/categories", "allowed" : [ "POST", "GET" ] }, "tasks" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199/tasks", "allowed" : [ "POST", "GET" ] }, "places" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199/places", "allowed" : [ "POST", "GET" ] }, "followingIn" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199/followingIn", "allowed" : [ "GET" ] }, "avatar" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199/avatar", "allowed" : [ "POST", "GET", "DELETE" ] }, "activity" : { "ref" : "https://example.jiveon.com/api/core/v3/places/13199/activities", "allowed" : [ "GET" ] } }, "id" : "1431" } }
Example:
Create Checkpoints
POST to /checkpoints/{projectID} creates a new checkpoint. You will need to pass a list that points to an array of checkpoints. Here we see an example of two checkpoints with their minimum set of fields:
{ "list": [ { "name": "Feature Complete", "dueDate": "2012-07-31T07: 00: 00.000+0000" }, { "name": "Code Freeze", "dueDate": "2012-09-31T07: 00: 00.000+0000" } ] }
Fields
Field | Type | Mode † | Description |
---|---|---|---|
description | String | optional | Human readable description of this checkpoint. |
dueDate | ISO 8601 Date | required | Date and time this checkpoint must be completed. |
id | String | read-only | Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs. |
name | String | required | Formal name for this checkpoint. |
project | Project | read-only | The project where this checkpoint lives. |
published | ISO 8601 Date | read-only | Date and time when this checkpoint was originally created. |
updated | ISO 8601 Date | read-only | Date and time this checkpoint was most recently updated. |
followed | Boolean | read-only | Whether the current user is following this object. Availability:Will be present only for object types that support being followed. |