ExtProps

ExtProps Service

Web service endpoints for functionality to list jive objects by extended properties.

Create System Ext Props

POST /extprops

Save a new set of extended properties for a system with specified characteristics, and return an entity representing the newly created extended properties.

Takes:
  • ExtProps describing the extended properties to be saved
    • Retrieves:
  • ExtProps representing the newly created extended props
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is malformed or max number of extended properties has been reached
    403 (Forbidden)You are not allowed to manage ext properties for person

    Destroy System Ext Props

    DELETE /extprops

    Delete the existing extended properties for the system.

    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to delete properties
    404 (Not Found)The specified person does not exist

    Get Objects By Ext Prop

    GET /extprops/{key}/{value}

    Return a paginated list of entities with that contains supplied extended property and value.

    Path Parameters:
    NameTypeRequiredDescription
    keyStringtrueProperty key
    valueStringtrueProperty value
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseThe zero-relative index of the first matching content to be returned
    countIntegerfalseThe maximum number of contents to be returned
    fieldsStringfalseThe fields to be returned on each content
    Retrieves:
  • Collection of matched entities (Content or Place or Person )
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful

    Get Objects By Ext Prop Key

    GET /extprops/{key}

    Return a paginated list of entities with that contains supplied extended property.

    Path Parameters:
    NameTypeRequiredDescription
    keyStringtrueProperty key
    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseThe zero-relative index of the first matching content to be returned
    countIntegerfalseThe maximum number of contents to be returned
    fieldsStringfalseThe fields to be returned on each content
    Retrieves:
  • Collection of matched entities (Content or Place or Person )
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful

    Get System Ext Props

    GET /extprops

    Return the specified extended properties for the system.

    Retrieves:
  • ExtProps containing the specified extended properties
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    404 (Not Found)If the specified person does not exist