PlaceTemplate

A Place Template represents an ordered list of Tile Definitions, as well as a list of External Stream Definitions, that will be used to populate the initial Tiles and External Streams for a Purposeful Place that this Place Template is applied to.

 {
    "id":"1018",
    "blurb":"Sell all the things",
    "description":"Dealroom template",
    "name":"Salesforce Dealroom",
    "tiles":[
       {
          // Tile JSON
       },
       ...
    ],
    "categories":[
       {
          // Place Template Category JSON
       },
       ...
    ],
    "extstreams":[
      {
          // External stream JSON
      },
      ...
    ],
    "headerSettings" : {
      "bgPresetImageUrl" : "",
      "bgRepeat" : "repeat",
      "bgPosition" : "left top",
      "bgType" : "preset",
      "staticResourcesEnabled" : false
    },
    "resources":{
       "self":{
          "allowed":[
             "PUT",
             "GET",
             "DELETE"
          ],
          "ref":"http://example.jiveon.com/api/core/v3/placeTemplates/1018"
       }
    },
    "type":"placeTemplateEntity"
 }

Since: 3.9

Fields

Field	Type	Mode †	Description
`author`	`String`	read-only	The person that created the place template.
`blurb`	`String`	optional	Short description of the place template.
`categories`	`PlaceTemplateCategory[]`	optional	The types of PlaceTemplateCategory to which this template applies.
`contentTypes`	`String[]`	optional	The content types which may be included in the place to which this template is applied. The types allowed may vary depending on the target place (see Group for example).
`description`	`String`	required	Description of this place template. There is a limit of 4000 characters.
`descriptionLocalized`	`String`	read-only	Description of this place template, localized according to the locale of the accessing user.
`displayName`	`String`	required	Name to use when displaying this place template. Names must be unique. There is a limit of 255 characters.
`displayNameLocalized`	`String`	read-only	Display name of this template, localized according to the locale of the accessing user.
`extensionUUID`	`String`	read-only	The UUID of the AddOn which contributed this template. May be empty if the template is a default, system defined one. Retrieves: the UUID value as a string
`extstreams`	`ExternalStreamDefinition[]`	optional	List of definitions of external streams that will appear on a page in a place. External stream definitions could be passed as URIs or as JSON of existing tile definitions.
`groupType`	`String`	optional	Applicable if the place is a Group. See the groupType on that entity for possible values.
`headerSettings`	`HeaderSettings`	required	An object representing the visual characteristics of the header banner applied to a place from this template.
`id`	`String`	read-only	Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive.
`name`	`String`	optional	Name of the place template. Names must be unique. Numbers are not allowed as names and there is a limit of 125 characters.
`resources`	`Object`	read-only	Resource links (and related permissions for the requesting person) relevant to this object.
`state`	`String`	optional	State of the place template. Possible values are: published - Template is available to be used archived - Template is no longer available
`subtitle`	`String`	optional	Subtitle for the place template. There is a limit of 125 characters.
`tags`	`String[]`	optional	Tags associated with this object.
`tiles`	`TileDefinition[]`	optional	List of definitions of tiles that will appear on a page in a place. Tile definitions could be passed as URIs or the JSON of existing tile definitions.
`global`	`Boolean`	optional	Flag indicating if a place created from this template is global. When global, the field categories needs to be empty.
`visibleToExternalContributors`	`Boolean`	optional	Flag indicating if a place created from this template is visible to external contributors.

Resources

Resource	Method	Description
`self`	`GET`	Return an updated version of this place template.
`self`	`PUT`	Update the information about this place template.
`self`	`DELETE`	Delete this place template.

PlaceTemplate

Since: 3.9

Fields

Retrieves:

Resources