Carousel

Fields

FieldTypeMode †Description
contentTypesString[]read-only

Blogs can only have Posts. Other content types cannot be added.

descriptionStringoptional

Human readable description of this place.

displayNameStringrequired

Display name of this place. It must be unique among places of the same type in this Jive instance. This value is used to compose the URL for the HTML presentation of this place in the Jive user interface, so its syntax must conform to the following rules:

  • It must contain only alpha-numeric characters, '-' or '_'.
  • It must contain less than 255 characters.
  • It must not be blank.
  • It must not be unique among places of the same type.
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.

likeCountIntegerread-only

Number of people who have liked this object.

Availability:

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

nameStringrequired

Formal name of this place. It must be unique among places of the same type in this Jive instance.

parentStringrequired

URI of the place that contains this blog. URI may either be to a place, or to a person (for a personal blog).

parentContentSummaryread-only

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

Availability:

Will be present in search results only.

parentPlaceSummaryread-only

Summary information about the place that contains this object.

Availability:

Will be present in search results only.

placeIDStringread-only

Internal Jive ID associated with the place.

placeTopicsPlaceTopic[]optional

List of place topics applied to this place

publishedISO 8601 Dateread-only

Date and time when this place was originally created.

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

Visibility status of this place ("Active", "Archived", "Deleted").

updatedISO 8601 Dateread-only

Date and time this place was most recently updated.

viewCountIntegerread-only

Number of times this place has been viewed.

Availability:

Will be present only for objects that support view counts

visibleToExternalContributorsBooleanoptional

Flag indicating that this place 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
activityGET

Return a paginated list of activities that have occurred within this place.

Retrieves:
  • Activity[]
    • announcementsPOST

    Create a new announcement associated with this place. An appropriate parent field will be calculated and injected automatically.

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

     {
  "content":
      {
      "type": "text/html",
      "text": "
    Some interesting text
    "
      },
  "subject": "Free beer for everyone"
 }

    Takes:
    Retrieves:
  • Announcement describing the new announcement
    • announcementsGET

    Return a paginated list of announcements for this place.

    Retrieves:
  • Announcement[]
    • avatarGET

    Return the binary content of the avatar image for this place.

    avatarPOST

    Register a new avatar image (or replace an existing one) for this place. The image will be downloaded and scaled as necessary.

    avatarDELETE

    Delete the existing avatar image for this place.

    blogGET

    Return the blog associated with this place.

    Retrieves:
  • Blog
    • categoriesGET

    Return the categories associated with this place.

    Retrieves:
  • Category[]
    • categoriesPOST

    Create a new category for this place with the specified characteristics, and return an entity describing it. The minimum information required to create a new category is:

       {
     "name": "Animals"
   }
    Takes:
    Retrieves:
  • Category describing the new category
    • contentsGET

    Return the first page of a paginated list of contents that are contained in this place.

    extpropsDELETE

    Deletes all extended properties for a place.

    Availability:

    Place should be editable to caller.

    extpropsGET

    Returns extended properties for a place.

    Availability:

    Place should be visible to caller.

    Retrieves:
  • ExtProps[]
    • extpropsPOST

    Creates extended properties for a place.

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

    Place should be editable to caller.

    Retrieves:
  • ExtProps[]
    • featuredContentGET

    Return a list of featured content objects in this place.

    Retrieves:
  • Content[]
    • followersGET

    Return a paginated list of the people following this place.

    Retrieves:
  • Person[]
    • Since: 3.5
    followingInGET

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

    Retrieves:
  • Stream[]
    • htmlGET

    URI of the HTML representation of this place.

    selfGET

    Return an updated version of this place.

    Retrieves:
  • Place describing this place
    • selfPUT

    Update the information about this place and return an updated entity.

    Retrieves:
  • Place describing this place
    • selfDELETE

    Delete this place and any related content.

    staticsPOST

    Create a new static resource for this place with the specified characteristics, and return an entity describing it.

         {
         "filename" : "{filename of the static resource}"
     }

    A description field may optionally be included as well.

    Retrieves:
  • Static describing the new static resource
    • Since: 3.1
    staticsGET

    Return the list of static resources associated with this place.

    Retrieves:
  • Static[]