How to use the additionalFields parameter in the Data Export Service (DES)

Document created by David Bastedo on Jun 29, 2017Last modified by umayal.manivasagam@jivesoftware.com on Mar 4, 2018
Version 2Show Document
  • View in full screen mode

 

Summary

With the V2 Data Export Service, all possible columns in a single API call are not returned by default. We've made a standard set of default columns (noted in V2 Data Export Service CSV Output Fields | JiveWorks )  and added the ability to add to that list whichever columns you need. You do this by using the additionalFields param. Refer to the V2 Data Export Service Query Parameters for information on how to use this parameter.

 

Versions

  • Verified for version: Jive 7, 8, 9, 2016.3

 

Details

 

This is a complete list of all additionalFields. Not all are available with all actions, and must be used for different activityType.

 

Event TypeAdditionalFieldDescription
MovefromContainerTypeThe type of place where the items came From (ie Social Group, Space, Project, or User container)
fromContainerIdThe numerated value of the place
fromContainerName
AttachmentattachmentFilename
attachmentContentTypeFile type of the attachment
attachmentCreationDate
attachmentModifiedDate
attachmentSize
CommentcommentId
commentSubject
commentCreationDate
commentModifiedDate
commentAuthors
commentStatusIs this comment published, pending moderation, etc.
commentUrl
commentParentAuthorAuthor of the reply that is being commented on
commentParentidID of the reply that is being commented on
isRootReplyIs this a reply to the main post (blog, document, or status update)
ShareshareSubject
shareCreationDate
shareModifiedDate
shareAuthors
shareStatusIs this share in moderation, reported for abuse, or published? The status will tell you this information.
shareRecipients
BookmarkbookmarkSubject
bookmarkCreationDate
bookmarkModifiedDate
bookmarkAuthors
bookmarkStatusIs this share in moderation, reported for abuse, or published? The status will tell you this information.
bookmarkBodyWhat is the notes on the bookmark.
bookmarkUrlThe URL of the content being bookmarked (ie http://www.cnn.com/ or https://community.aurea.com/docs/DOC-35149
MentionmentionId
mentionName
mentionType
mentionUrl
OutcomeoutcomeId
outcomeTypeThis is the type of Outcome used. Ie Outdate, Final, etc.
outcomeApprovers
outcomeNote
outcomeStatusIs this share in deleted, in moderation, reported for abuse, or published? The status will tell you this information.
outcomePredecessorId
outcomeParentId
outcomeParentTypeThis is the content type, ie message, comment, Blog post, document, etc.
outcomeParentContainerId
outcomeParentContainerType
EmailemailSender
emailRecipients
emailSubject
emailCombinedParentObjectTypeIdThis id the ID of the items that generate the email notification.
InvitationinvitationId
invitationCreationDate
invitationObjectId
invitationObjectType
invitationInviter
invitationEmail
Status Point ChangedpointTotalThe specified item was not found. - Doesn't look like this is BB or Rewards
MessageisRootMessage
belongsToQuestion
messageParentId
forumThreadId
ExpertiseendorsementTagName
endorsementTagUnfilteredName
endorsementTagId
endorsementTagObjectType
endorsementApprovalStep
AcclaimacclaimId
acclaimType
SearchsearchSelectedId
searchSelectedType
searchFinalQuery
PermissionspermissionLevelId
permissionLevelName
oldPermissionLevelId
oldPermissionLevelName
Direct Messages, Shares, and MentionsrecipientUser
Eventresponse
CollaborationaffectedCollaborationUsers

 

 

 

 

 

 

 

 

Related Information

Attachments

    Outcomes