Page

Page Service

Pages belong to people or places and can be managed by this service. Additionally they can be retrieved by calls to getPages(placeID, filters, fields) and getPages(personID, filters, fields)

Person pages ("Your View") and Activity place pages behave differently than other pages. Your View and Activity have specific layouts and naming restrictions. They are not available for retrieval until they are created via an API call or modified via the UI. Until then, a default page is rendered when a user visits Your View or Activity and these pages will NOT be returned when calling getPages(placeID, filters, fields) and getPages(personID, filters, fields)

Since: 3.9

Create Page

POST /pages

Create a page for a person or place as specified by parent.

The number pages that can be created per place is determined by the system property jive.pages.current.max

Example:

curl -u admin:password -X POST -H "Content-Type: application/json" -d "@create-page.json" http://example.jiveon.com/api/core/v3/pages

Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseThe fields to be returned on each instance
Takes:
  • Page describing the page to be created
    • Retrieves:
  • Page representing the newly created page
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is missing or malformed
    404 (Not Found)The specified instance cannot be found
    403 (Forbidden)You are not allowed to perform this operation
    409 (Conflict)The new entity would conflict with system restrictions (such as duplicate names or pages limit)

    Destroy Page

    DELETE /pages/{pageID}

    Delete the specified page.

    Example:

    curl -u admin:password -X DELETE http://example.jiveon.com/api/core/v3/pages/1234

    Path Parameters:
    NameTypeRequiredDescription
    pageIDStringtrueID of the page to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)The pageID was not a valid identifier
    403 (Forbidden)You are not allowed to delete this page
    404 (Not Found)A page with this pageID does not exist

    Get Page

    GET /pages/{pageID}

    Retrieve a page by ID

    Example:

    curl -u admin:password -X GET http://example.jiveon.com/api/core/v3/pages/1234

    Path Parameters:
    NameTypeRequiredDescription
    pageIDStringtrueID of the page to retrieve
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • Page
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)The pageID was not a valid identifier
    403 (Forbidden)You are not allowed to view this page
    404 (Not Found)A page with this pageID does not exist

    Get Prototype Page

    GET /pages/prototype

    Return a new page, that is not persistent, based on the specified place template. From the Page that is returned by this service, you must supply the following in order to persist it:

    • layout (see Page layout field for options)
    • for each TileInstance, specify a target column in the chosen or default layout
    • for each ExternalActivity, specify a target column in the chosen or default layout

    Query Parameters:
    NameTypeRequiredDescription
    placeTemplateIDStringtrueplaceTemplateID ID of the place template to be used as a template for the new page
    placeURIStringtrueplaceURI the place that will own the new page once it is saved
    fieldsStringfalseFields to be returned
    Retrieves:
  • Page
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is malformed
    404 (Not Found)The specified place template does not exist
    403 (Forbidden)You are not allowed to perform this operation

    Update Page

    PUT /pages/{pageID}

    Update a page

    Example:

    curl -u admin:password -X PUT -H "Content-Type: application/json" -d "@page.json" http://example.jiveon.com/api/core/v3/pages

    Path Parameters:
    NameTypeRequiredDescription
    pageIDStringtrueID of the page to update
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Takes:
  • Page containing the updates to the page
    • Retrieves:
  • Page representing the updated page
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)The pageID was not a valid identifier or there is invalid data in the entity parameter
    403 (Forbidden)You are not allowed to update this page
    404 (Not Found)A page with this pageID does not exist
    409 (Conflict)The updated entity would conflict with system restrictions (such as duplicate names)