OutcomeType

The metadata describing an outcome type, including the fields it includes.

Fields

FieldTypeMode Description
alternativeGroupingStringread-only

Returns true as a hint that clients may want to display this outcome type separately from the normal group of outcome types available to be set on a content item by viewers

Retrieves:
  • true as a hint that clients may want to display this outcome type separately from the normal group of outcome types available to be set on a content item by viewers
  • communityAudienceStringread-only

    If the audience for the outcome type when applied is the entire community.

    confirmContentEditStringread-only

    Returns the string "true" if clients should provide a warning to any potential editors of the top level content item that did not mark that item with the currently marked outcome.

    confirmExclusionBooleanread-only
    confirmUnmarkBooleanread-only
    fieldsField[]read-only

    Metadata about the fields that may be present in the JSON representation of this object type.

    generalNoteBooleanread-only
    idStringread-only

    The unique identifier of this outcome type.

    nameStringread-only

    The name of this outcome type.

    noteRequiredBooleanread-only
    resourcesObjectread-only

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

    shareableBooleanread-only
    typeStringread-only

    The object type of this object ("outcomeType").

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