osapi.jive.corev3.solutions.supportcenter.Section
Properties
Properties
Property | Type | Mode † | Description |
---|---|---|---|
displayOrder | Integer | optional | ↑ The index of the total ordering in which this section should be displayed with it's solution key group. If this is not specified in a call to create a section, it will default to the last position. If this is not specified in a call to update a section, the order will not be modified. |
id | String | read-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. |
name | String | required | ↑ Name of this section. |
published | ISO 8601 Date | read-only | ↑ Date and time this object was originally created. |
resources | Object | read-only | ↑ Resource links (and related permissions for the requesting person) relevant to this object. |
sectionEntries | SectionEntry[] | optional | ↑ An ordered list of section entries associated with this section. |
sectionType | String | optional | ↑ The section type of this section. Must be one of "header", "block", or "footer". "header" is intended to be used as the top "banner" section of a page. "block" is intended to be used for the middle sections on a page that contains "place" section entries. "footer" is intended to contain "channel" section entries that link to other media channels. |
solutionKey | String | required | ↑ The solution key associated with this section. Each solution page (e.g. Support Center) will have its own solution key. Currently, the only valid value is "supportcenter". |
type | String | read-only | ↑ |
typeCode | Integer | read-only | ↑ |
updated | ISO 8601 Date | read-only | ↑ Date and time this object was most recently updated. |
Methods
destroy()
DELETE /sections/1234
Retrieves
Object
Description
Delete this section.
Availability:
Available to Jive admins only
get(options)
GET /sections/1234
Retrieves
Section
Description
Return an updated version of this section.
Availability:
Available to Jive admins only
Options:
Name | Type | Required | Description |
---|---|---|---|
fields | String | false | The names of the fields to be returned |
Retrieves:
toURI()
Retrieves
String