osapi.jive.corev3.solutions.supportcenter.Section

Properties

PropertyTypeMode Description
displayOrderIntegeroptional

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.

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.

nameStringrequired

Name of this section.

publishedISO 8601 Dateread-only

Date and time this object was originally created.

resourcesObjectread-only

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

sectionEntriesSectionEntry[]optional

An ordered list of section entries associated with this section.

sectionTypeStringoptional

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.

solutionKeyStringrequired

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

typeStringread-only
typeCodeIntegerread-only
updatedISO 8601 Dateread-only

Date and time this object was most recently updated.

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

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:
NameTypeRequiredDescription
fieldsStringfalseThe names of the fields to be returned
Retrieves:
  • Section representing the updated section
  • toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • update(options)
    PUT /sections/1234

    Retrieves

    Section

    Description

    Update the information about this section.

    Availability:

    Available to Jive admins only

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseThe names of the fields to be returned
    Retrieves:
  • Section representing the updated section