DirectMessage

A direct message from one person to a defined set of participants, which are enumerated in the participants field. Corresponds to creating a "Message" from the Create menu in Jive. See the /dms service.

Examples:

Example JSON

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

{
  "type" : "dm",
  "status" : "published",
  "subject" : "Message for you",
  "parent" : "https://example.jiveon.com/api/core/v3/people/2001",
  "content" : {
    "type" : "text/html",
    "text" : "Let's meet at 4"
  },
  "author" : {
    "name" : {
      "givenName" : "Vicky",
      "familyName" : "Employee",
      "formatted" : "Vicky Employee"
    },
    "type" : "person",
    "displayName" : "Vicky Employee",
    "id" : "2001"
  },
  "participants" : [ {
    "name" : {
      "formatted" : "Bob Goodwin"
    },
    "type" : "person",
    "displayName" : "Bob Goodwin",
    "id" : "1"
  } ],
  "id" : "1004",
  "resources" : {
    "self" : {
      "ref" : "https://example.jiveon.com/api/core/v3/dms/1004",
      "allowed" : [ "DELETE", "GET" ]
    },
    "html" : {
      "ref" : "https://example.jiveon.com/inbox/dm/1004",
      "allowed" : [ "GET" ]
    },
    "comments" : {
      "ref" : "https://example.jiveon.com/api/core/v3/dms/1004/comments",
      "allowed" : [ "POST", "GET" ]
    }
  }
}

Direct Message Creation

POST to /dms creates a new direct message. The minimum set of fields you must include are:

 {
  "content":
      {
      "type": "text/html",
      "text": "<body><p>Some interesting text to discuss</p></body>"
      },
  "participants": ["http://example.jiveon.com/api/core/v3/people/2012"]
  }

Fields

Field	Type	Mode †	Description
`abuseCount`	`Integer`	read-only	Number of abuse reports associated with this content object.
`author`	`Person`	read-only	Author of this content object.
`content`	`ContentBody`	required	Content of this content object.
`contentID`	`String`	read-only	Internal Jive ID associated with the content.
`contentImages`	`Image[]`	read-only	A list of Image objects providing metadata about images embedded within this content.
`contentVideos`	`ContentVideo[]`	read-only	A list of ContentVideo objects providing metadata about videos embedded within this content.
`favoriteCount`	`Integer`	read-only	Number of people who have bookmarked this object. Availability: Will be present only for object types that support being bookmarked. Since: 3.11
`followerCount`	`Integer`	read-only	Number of people following this object. Availability: Will be present only for object types that support being followed.
`highlightBody`	`String`	read-only	Highlight snippet of a search match in the body or description. Availability: Will be present in search results only.
`highlightSubject`	`String`	read-only	Highlight snippet of a search match in the subject or name. Availability: Will be present in search results only.
`highlightTags`	`String`	read-only	Highlight snippet of a search match in tags. Availability: Will be present in search results only.
`iconCss`	`String`	read-only	CSS Style to locate icon within sprite.
`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.
`lastActivityDate`	`ISO 8601 Date`	read-only	Date and time when this had its last activity. Since: 3.12
`likeCount`	`Integer`	read-only	Number of people who have liked this object. Availability: Will be present only for object types that support being liked.
`parent`	`String`	read-only	URI of the person who sent the direct message.
`parentContent`	`Summary`	read-only	Summary information about the content object that is the parent of this object. Availability: Will be present in search results only.
`parentContentVisible`	`Boolean`	read-only	Flag indicating that the content parent's contents are visible to the viewer.
`parentPlace`	`Summary`	read-only	Summary information about the place that contains this object. Availability: Will be present in search results only.
`parentVisible`	`Boolean`	read-only	Flag indicating that the content parent is visible to the viewer.
`participants`	`Person[]`	required	The people to whom this direct message was sent.
`published`	`ISO 8601 Date`	read-only	Date and time when this content object was originally created.
`replyCount`	`Integer`	read-only	Number of replies to this object. Availability: Will be present only for object types that support replies.
`resources`	`Object`	read-only	Resource links (and related permissions for the requesting person) relevant to this object.
`searchRankings`	`Object`	read-only	A map of search result scores including social signals. Availability: Will be present in search results only.
`status`	`String`	read-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
`subject`	`String`	read-only	Subject of this content object.
`tags`	`String[]`	optional	Tags associated with this object. Availability: Will be present only for object types that support tags
`type`	`String`	read-only	The object type of this object ("dm").
`typeActual`	`String`	read-only	The object type of this object ("dm").
`updated`	`ISO 8601 Date`	read-only	Date and time this content object was most recently updated.
`viewCount`	`Integer`	read-only	Number of times this content object has been viewed. Availability: Will be present only for objects that support view counts
`visibleToExternalContributors`	`Boolean`	read-only	Flag indicating that this content object is potentially visible to external contributors.
`followed`	`Boolean`	read-only	Whether the current user is following this object. Availability: Will be present only for object types that support being followed.
`promotedResult`	`Boolean`	read-only	A boolean determining whether this search result is a promoted result Availability: Will be present in search results only.

Resources

Resource	Method	Description
`childOutcomeTypes`	`GET`	Return a paginated list of possible outcomes types on the content object's children. Retrieves: OutcomeType[]
`images`	`GET`	Return metadata about the images attached to this direct message. Retrieves: Image[]
`extprops`	`DELETE`	Deletes all extended properties for content. Availability: Content should be editable to caller.
`extprops`	`GET`	Returns extended properties for content. Availability: Content should be visible to caller. Retrieves: ExtProps[]
`extprops`	`POST`	Creates extended properties for content. { "any prop name": "any val", "any prop2 name": "any val" } Availability: Content should be editable to caller. Retrieves: ExtProps[]
`html`	`GET`	Return the HTML representation of this direct message.
`read`	`POST`	Mark this direct message as having been read. Since: 3.2
`read`	`DELETE`	Mark this direct message as having not been read. Since: 3.2
`outcomes`	`POST`	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: Outcome the outcome to be created. Retrieves: Outcome Representation of the newly created outcome
`outcomes`	`GET`	Return a paginated list of outcomes on the content. Retrieves: Outcome[]
`outcomeTypes`	`GET`	Return a paginated list of possible outcomes types on the content. Retrieves: OutcomeType[]
`messages`	`GET`	Return a paginated list of replies to this direct message. Retrieves: Comment[]
`comments`	`POST`	Create a new reply to this message, and return a Comment representing the new object. Takes: Comment fields describing the new reply Retrieves: Comment describing the newly created reply
`self`	`GET`	Return an updated version of this direct message. Retrieves: DirectMessage representing the updated direct message
`self`	`DELETE`	Delete this direct message and all replies associated with it.
`subject`	`POST`	Sets the subject (text) of this direct message. Takes: DirectMessage fields (or just the subject field) with the modified subject (text) Retrieves: DirectMessage representing the updated direct message

DirectMessage

Examples:

Example JSON

Direct Message Creation

Fields

Availability:

Since: 3.11

Availability:

Availability:

Availability:

Availability:

Since: 3.12

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Availability:

Resources

Retrieves:

Retrieves:

Availability:

Availability:

Retrieves:

Availability:

Retrieves:

Since: 3.2

Since: 3.2

Availability:

Takes:

Retrieves:

Retrieves:

Retrieves:

Retrieves:

Takes:

Retrieves:

Retrieves:

Takes:

Retrieves: