Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.

osapi.jive.corev3.contents.Stage

Jive Core API entity representing the stage of an idea. An example JSON representation looks like this:

 {
     "name" : "Active",
     "id" : "1",
     "type" : "stage",
     "votingEnabled" : true,
     "backgroundColor" : "#EEFFEE",
     "foregroundColor" : "#666666",
     "stageDefault" : true,
     "stageEnabled" : true,
     "ideasCount" : 3,
     "resources" : {
       "self" : {
         "ref" : "https://example.jiveon.com/api/core/ext/idea-type-plugin/v1/stages/1",
         "allowed" : [ "GET", "PUT", "DELETE" ]
       }
     }
   }
Availability:

Available only when the Ideation plugin is installed in this Jive instance

Since: 3.1

Properties

PropertyTypeMode Description
backgroundColorStringoptional

Background color for the label of this stage. Must be of the form "#xxxxxx" where each "x" is a hexadecimal character.

foregroundColorStringoptional

Foreground color for the label of this stage. Must be of the form "#xxxxxx" where each "x" is a hexadecimal character.

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.

ideasCountIntegerread-only

Number of ideas within this Jive instance that are currently classified in this stage.

nameStringoptional

Name of this stage.

resourcesObjectread-only

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

stageDefaultBooleanoptional

Flag indicating whether this is the default stage for newly created ideas. Exactly one stage MUST have true for this field.

stageEnabledBooleanoptional

Flag indicating whether this stage is enabled for use in classifying ideas.

typeStringread-only

The object type of this object ("stage").

votingEnabledBooleanoptional

Flag indicating whether ideas classified in this stage may be voted on.

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