osapi.jive.corev3.places.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

Read createCategory() to learn how to create a new category.

Properties

PropertyTypeMode †Description
descriptionStringoptional↑
Description 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.

isFollowedBooleanread-only↑

Whether the current user is following this object.

Availability:

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

likeCountIntegerread-only↑

Number of people who have liked this object.

Availability:

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

nameStringrequired↑
Name 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.

typeCodeIntegerread-only↑
updatedISO 8601 Dateread-only↑

Date and time this object was most recently updated.

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

Methods

↑
destroy()
DELETE /places/1234/categories/1002

Retrieves

--

Description

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

↑
get(options)
GET /places/1234/categories/1002

Retrieves

Category

Description

Return an updated version of this category.

Options:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Category representing the updated category
    • ↑
    toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
    • ↑
    update(options)
    PUT /places/1234/categories/1002

    Retrieves

    Category

    Description

    Update the information about this category.

    Options:
    NameTypeRequiredDescription
    autoCategorizeStringfalseBoolean indicating whether existing content of the place will be categorized under the new category
    Retrieves:
  • Category representing the updated category