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

FieldTypeMode Description
authorStringread-only

The person that created the place template.

blurbStringoptional

Short description of the place template.

categoriesPlaceTemplateCategory[]optional

The types of PlaceTemplateCategory to which this template applies.

contentTypesString[]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).

descriptionStringrequired

Description of this place template. There is a limit of 4000 characters.

descriptionLocalizedStringread-only

Description of this place template, localized according to the locale of the accessing user.

displayNameStringrequired

Name to use when displaying this place template. Names must be unique. There is a limit of 255 characters.

displayNameLocalizedStringread-only

Display name of this template, localized according to the locale of the accessing user.

extensionUUIDStringread-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
  • extstreamsExternalStreamDefinition[]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.

    groupTypeStringoptional

    Applicable if the place is a Group. See the groupType on that entity for possible values.

    headerSettingsHeaderSettingsrequired

    An object representing the visual characteristics of the header banner applied to a place from this template.

    idStringread-only

    Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive.

    nameStringoptional

    Name of the place template. Names must be unique. Numbers are not allowed as names and there is a limit of 125 characters.

    resourcesObjectread-only

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

    stateStringoptional

    State of the place template. Possible values are:

    • published - Template is available to be used
    • archived - Template is no longer available

    subtitleStringoptional

    Subtitle for the place template. There is a limit of 125 characters.

    tagsString[]optional

    Tags associated with this object.

    tilesTileDefinition[]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.

    globalBooleanoptional

    Flag indicating if a place created from this template is global. When global, the field categories needs to be empty.

    visibleToExternalContributorsBooleanoptional

    Flag indicating if a place created from this template is visible to external contributors.

    → 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 place template.

    selfPUT

    Update the information about this place template.

    selfDELETE

    Delete this place template.