TileDefinition

A Tile Definition represents a type of Tile. A Tile Definition defines the style and default data for a type of tile. It also includes information needed to register, configure, and perform actions with this tile.
 {
   "id" : "1005",
   "client_id" : "4ac82e5c-e537-4384-b4e6-9614dcf43886",
   "displayName" : "List of contacts",
   "register" : "http://myservice.com/register",
   "style" : "list",
   "configurationRequired" : false,
   "name" : "Contacts tile",
   "categories":[
     {
       // Integration Tile Category JSON
     },
     ...
   ],
   "state" : "published",
   "type" : "tileDefinition",
   "published" : "2013-01-12T00:19:48.992+0000",
   "updated" : "2013-01-12T00:19:48.992+0000",
   "icons" : {
     "16" : "https://example.jiveon.com/api/core/v3/images/1011",
     "48" : "https://example.jiveon.com/api/core/v3/images/1012",
     "128" : "https://example.jiveon.com/api/core/v3/images/1013"
   },
   "resources" : {
     "self" : {
       "allowed" : [ "DELETE", "GET" ],
       "ref" : "https://example.jiveon.com/api/core/v3/tiles/definitions/1005"
     }
   }
 }

Fields

FieldTypeMode Description
actionStringoptional

URL that provides the processing logic for handling clicks on actions in the presentation of data from this Tile

addOnAddOnread-only
categoriesTileCategory[]optional
client_idStringoptional
configStringoptional

URL of an HTML file used for powering a custom view (like a lightweight app) to configure the tile

defaultConfigSharedStringoptional
descriptionStringoptional
descriptionLocalizedStringread-only
displayNameStringrequired
displayNameLocalizedStringread-only
displayWidthStringread-only

String representing the supported display width. Valid values are "narrow", "wide", and "all".

iconsObjectoptional
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.

isDeletableBooleanread-only
nameStringrequired
pageTypesString[]read-only

List of supported tile page types. Valid values are "place", "user", and "mobile".

productNameStringoptional
publishedISO 8601 Dateread-only
registerStringoptional
resourcesObjectread-only

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

sampleDataObjectoptional

Sample of the data that can be pushed to instances of this definition. Possible values are: Configuration of this instance in JSON format.

stateStringoptional

State of this definition. Possible values are:

  • published - Definition is available to be used
  • archived - Definition is no longer available
  • disabled - Definition is disabled because features it rely on are not available in this system
  • locked - Custom definition is used by one user and is locked
  • unlocked - Custom definition created by one user and is unlocked
  • global_locked - Custom definition can be used by one user and is locked
  • global_unlocked - Custom definition can be used by any user

styleStringoptional

String representing the style of this tile definition. Valid values are:

  • CALENDAR
  • LIST
  • GAUGE
  • ACTIVITY
  • TABLE
  • GALLERY
  • CONTENT
  • CONTENTLISTWIDE
  • CONTENTLISTNARROW
  • SECTIONLIST
  • CAROUSEL
  • QUESTION
  • CUSTOM_VIEW

unregisterStringoptional
updatedISO 8601 Dateread-only
usesOAuth2Booleanoptional
viewStringoptional

URL of an HTML file used for rendering a custom view tile. The HTML file will be part of a lightweight app that will render inside of the tile only.

configurationRequiredBooleanread-only

Whether or not this tile requires configuration to be completed before being visible to the end user.

→ 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 tile definition.

selfDELETE

Delete this tile definition.