Task

An entity representing a task. Tasks can be personal tasks or inside projects.

Examples:
Example JSON

JSON including important fields and a Task's resources. See the tables below for a list of all fields and resources.

{
  "type" : "task",
  "status" : "published",
  "subject" : "Clean the carpet",
  "parent" : "https://example.jiveon.com/api/core/v3/people/1",
  "content" : {
    "type" : "text/html",
    "text" : "<body>Replace the broken vacuum cleaner, then clean the carpet.</body>"
  },
  "contentImages" : [ {
    "id" : "1055",
    "contentType" : "image/jpeg",
    "name" : "pic.jpeg",
    "ref" : "http://example.jiveon.com/api/core/v3/attachments/file/1055/data",
    "size" : 5953,
    "width" : 251,
    "height" : 201,
    "type" : "image"
  } ],
  "author" : {
    "name" : {
      "formatted" : "Administrator"
    },
    "type" : "person",
    "displayName" : "Administrator",
    "id" : "1"
  },
  "owner" : "https://example.jiveon.com/api/core/v3/people/1",
  "completed" : false,
  "followerCount" : 1,
  "dueDate" : "2012-07-12T06:59:59.999+0000",
  "published" : "2012-07-10T22:20:15.749+0000",
  "updated" : "2012-07-10T22:20:15.749+0000",
  "visibleToExternalContributors" : false,
  "tags" : [ ],
  "id" : "1001",
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1240",
      "allowed" : [ "PUT", "DELETE", "GET" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/tasks/1001",
      "allowed" : [ "GET" ]
    },
    "followingIn" : {
      "ref" : "https://example.jiveon.com/api/core/v3/contents/1240/followingIn",
      "allowed" : [ "GET" ]
    }
  }
}
Create Personal Task

POST to /people/{personID}/tasks creates a new personal task. The minimum set of fields you must include are: 

 {
  "subject": "Clean the carpet",
  "dueDate" : "2013-07-12T06:59:59.999+0000",
  "type": "task"
  }
Create Project Task

POST to /places/{placeID}/tasks creates a new task in a project. The minimum set of fields you must include are: 

 {
  "subject": "Clean the carpet",
  "dueDate" : "2013-07-12T06:59:59.999+0000",
  "type": "task"
  }

Fields

FieldTypeMode †Description
abuseCountIntegerread-only

Number of abuse reports associated with this content object.

authorPersonread-only

Author of this content object.

completedBooleanoptional

Flag indicating that this task has been completed. This field is required during update operations.

contentContentBodyoptional

Associated notes to this task.

contentIDStringread-only

Internal Jive ID associated with the content.

contentImagesImage[]read-only

A list of Image objects providing metadata about images embedded within this content.

contentVideosContentVideo[]read-only

A list of ContentVideo objects providing metadata about videos embedded within this content.

dueDateISO 8601 Daterequired

The date that this task is scheduled to be completed.

favoriteCountIntegerread-only

Number of people who have bookmarked this object.

Availability:

Will be present only for object types that support being bookmarked.

Since: 3.11
followerCountIntegerread-only

Number of people following this object.

Availability:

Will be present only for object types that support being followed.

highlightBodyStringread-only

Highlight snippet of a search match in the body or description.

Availability:

Will be present in search results only.

highlightSubjectStringread-only

Highlight snippet of a search match in the subject or name.

Availability:

Will be present in search results only.

highlightTagsStringread-only

Highlight snippet of a search match in tags.

Availability:

Will be present in search results only.

iconCssStringread-only

CSS Style to locate icon within sprite.

idStringread-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.

lastActivityDateISO 8601 Dateread-only

Date and time when this had its last activity.

Since: 3.12
likeCountIntegerread-only

Number of people who have liked this object.

Availability:

Will be present only for object types that support being liked.

ownerStringoptional

The owner of this task. This is typically the person responsible for accomplishing the task. For personal tasks this can only be the user that created the task. If none was specified for project tasks then the user creating or updating the task will become the owner.

parentStringrequired

URI of the parent project or person, for personal tasks, of this content object. When creating a task from the person service or the place service then this field is not required since it is inferred from the context.

parentContentSummaryread-only

Summary information about the content object that is the parent of this object.

Availability:

Will be present in search results only.

parentContentVisibleBooleanread-only

Flag indicating that the content parent's contents are visible to the viewer.

parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

parentTaskStringoptional

The parent task, if this is a sub-task.

parentVisibleBooleanread-only

Flag indicating that the content parent is visible to the viewer.

publishedISO 8601 Dateread-only

Date and time when this content object was originally created.

replyCountIntegerread-only

Number of replies to this object.

Availability:

Will be present only for object types that support replies.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

searchRankingsObjectread-only

A map of search result scores including social signals.

Availability:

Will be present in search results only.

statusStringread-only

Published status of this content object.

  • incomplete - Content object is in draft mode
  • awaiting moderation - Content object is waiting for moderation by an approver
  • rejected - Content object has been rejected for publication by an approver
  • published - Content object has been published
subjectStringrequired

Subject of this content object.

subTasksString[]read-only

The sub-tasks of this task.

tagsString[]optional

Tags associated with this object.

Availability:

Will be present only for object types that support tags

typeStringrequired

The object type of this object ("task"). This field is required when creating new content.

updatedISO 8601 Dateread-only

Date and time this content object was most recently updated.

viewCountIntegerread-only

Number of times this content object has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanread-only

Flag indicating that this content object is potentially visible to external contributors.

followedBooleanread-only

Whether the current user is following this object.

Availability:

Will be present only for object types that support being followed.

promotedResultBooleanread-only

A boolean determining whether this search result is a promoted result

Availability:

Will be present in search results only.

†
→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Resources

ResourceMethodDescription
childOutcomeTypesGET

Return a paginated list of possible outcomes types on the content object's children.

Retrieves:
  • OutcomeType[]
    • extpropsDELETE

    Deletes all extended properties for content.

    Availability:

    Content should be editable to caller.

    extpropsGET

    Returns extended properties for content.

    Availability:

    Content should be visible to caller.

    Retrieves:
  • ExtProps[]
    • extpropsPOST

    Creates extended properties for content.

     {
  "any prop name": "any val",
  "any prop2 name": "any val"
 }
    Availability:

    Content should be editable to caller.

    Retrieves:
  • ExtProps[]
    • followersGET

    Return a paginated list of the people following this content.

    Retrieves:
  • Person[]
    • Since: 3.5
    followingInGET

    Return the list of custom streams in which the requesting person is following this task (if any).

    Retrieves:
  • Stream[]
    • htmlGET

    Return the HTML representation of this content object.

    readPOST

    Mark this task as having been read.

    Since: 3.2
    readDELETE

    Mark this task as having not been read.

    Since: 3.2
    outcomesPOST

    Register that the requesting person created the outcome.

    Here is an example of a JSON with the minimum set of fields you must include: 

    {
  "outcomeType":
      {
          "id": 1
      }
}

    Availability:

    Must be authenticated, must not be able to read the content, and must not have the same outcome type on this comment already

    Takes:
    Retrieves:
  • Outcome Representation of the newly created outcome
    • outcomesGET

    Return a paginated list of outcomes on the content.

    Retrieves:
  • Outcome[]
    • outcomeTypesGET

    Return a paginated list of possible outcomes types on the content.

    Retrieves:
  • OutcomeType[]
    • selfGET

    Return an updated version of this content object.

    Retrieves:
  • Content describing this content object
    • selfPUT

    Update the information about this content object.

    Retrieves:
  • Content representing the updated content object
    • selfDELETE

    Delete this content object and any related comments and other related information.