static osapi.jive.corev3.metadata

Static class for getting Metadata about the available javascript classes, fields, and methods. Also provides metadata about your Jive instance.

Methods

↑
getAllObjectMetadata(options)
GET /metadata/objects/@all

Retrieves

Object[]

Description

Return the object metadata for all defined object types. The nested fields and resources information will be omitted -- retrieve the object metadata for each individual object type if you need that.

Since: 3.3
↑
getAllPropertyMetadata()
GET /metadata/properties

Retrieves

Property[]

Description

Return all of the property metadata for this Jive instance.

Retrieves:
  • Property[]
    • ↑
    getAllTimeZoneMetadata()
    GET /metadata/timezones

    Retrieves

    TimeZone[]

    Description

    Return all of the time zone metadata for this Jive instance.

    Retrieves:
  • TimeZone[] describing the time zones
    • ↑
    getAvailableLocaleMetadata()
    GET /metadata/locales/available

    Retrieves

    Locale[]

    Description

    Return a list of all locales that are available (whether or not they have specific translations).

    Retrieves:
  • Locale[] describing the locales
    • ↑
    getFieldMetadata(options)
    GET /metadata/objects/{name}/{field}

    Retrieves

    Field

    Description

    Return the field metadata for the specified field of the specified object type.

    Options:
    NameTypeRequiredDescription
    nameStringtrueThe name of the object type for which to return metadata
    fieldStringtrueThe name of the field for which to return metadata
    Retrieves:
  • Object
    • ↑
    getFieldMetadataValues(options)
    GET /metadata/objects/{name}/{field}/values

    Retrieves

    Array

    Description

    ↑
    getObjectMetadata(options)
    GET /metadata/objects/{name}

    Retrieves

    Object

    Description

    Return the object metadata for the specified object type.

    Options:
    NameTypeRequiredDescription
    nameStringtrueThe name of the object type for which to return metadata
    Retrieves:
  • Object
    • ↑
    getObjectMetadataValues(options)
    GET /metadata/objects/{name}/values

    Retrieves

    Object

    Description

    ↑
    getObjectTypes()
    GET /metadata/objects

    Retrieves

    Object

    Description

    Return a mapping of object names to URIs to retrieve object metadata for all known object types.

    Retrieves:
  • Map with key = object name and value = URI
    • ↑
    getPropertyMetadata(options)
    GET /metadata/properties/{name}

    Retrieves

    Property

    Description

    Return the requested configuration property, with their current settings.

    Options:
    NameTypeRequiredDescription
    nameStringtrueName of the requested configuration property
    Retrieves:
  • Property
    • Since: 3.1
    ↑
    getSupportedLocaleMetadata()
    GET /metadata/locales/supported

    Retrieves

    Locale[]

    Description

    Return a list of all locales supported by this Jive instance with specific translations.

    Retrieves:
  • Locale[] describing the locales