Category

A Category is a way to organize content within a place. Categories have a name, tags, and a parent place. When creating or updating content, you can specify a list of categories for that content object. An example JSON representation looks like this:

 {
    "name" : "Animals",
    "tags" : [ ],
    "place" : "https://example.jiveon.com/api/core/v3/places/1116",
    "id" : "1002",
    "resources" : {
      "self" : {
        "ref" : "https://example.jiveon.com/api/core/v3/places/1116/categories/1002",
        "allowed" : [ "GET", "DELETE", "PUT" ]
      }
    }
 }
Example:
Create Category

POST to /places/{placeID}/categories creates a new category. The minimum set of fields you must include are: 

 {
  "name": "Animals"
  "type": "category"
  }

Fields

FieldTypeMode †Description
descriptionStringoptionalDescription of the category.
followerCountIntegerread-only

Number of people following this object.

Availability:

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

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.

nameStringrequiredName of the category.
placeStringread-only

URI of the place where this category belongs.

publishedISO 8601 Dateread-only

Date and time this object was originally created.

resourcesObjectread-only

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

tagsString[]optional

Tags associated with this object.

typeStringrequired

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

updatedISO 8601 Dateread-only

Date and time this object was most recently updated.

followedBooleanread-only

Whether the current user is following this object.

Availability:

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

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

Resources

ResourceMethodDescription
selfGET

Return an updated version of this category.

Retrieves:
  • Category representing the updated category
    • selfPUT

    Update the information about this category.

    Retrieves:
  • Category representing the updated category
    • selfDELETE

    Delete the existing category for the specified place. Only admins of the place can manage place categories.