System Page APIs
Get System Pages List

Get System Pages List

OVERVIEW

Overview

Get list of System pages from Publisher. 

Page Description
Home Visible to system users and for public user if home dashboard is set 'Public'.
Browse Visible to system users and for public user if any public module is present.
Search Visible to system users and for public user if any public module is present.
People Directory Visible to the users having people directory view access.
User Preferences Visible to system users only.
System Preferences Visible to system users only.
Login Page Visible to system user and public user.

 

Requests are made via POST to enable complexity of the request.

Since v5.1

HTTP Request

POST  /api/2/systempages

HTTP Request Object

System pages search request object either in JSON or XML format.

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
Content-Type

The format of the provided content.

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the expected content by default.

 "application/json"

 

API Accessibility

Access Type Description
API Token without user parameter Any user who has API token, can access the API.
API Token of System Admin with user parameter If API token is of system admin then 'user' parameter can be passed, allowing to call the API on that user's behalf.
API Token of user other than System Admin with user parameter

Not allowed and results in below with response code 400

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>108</ref>
    <summary>The requested user does not exist</summary>
</error>

 

Parameter details

Parameter Description Example
user User email on behalf of whom the API is called  "user": "ua@mi.com"
limit Maximum number of results to fetch. Default value is 30  "limit": "7"
offset Page number. Default value is 0  "offset": "0"
search Search page names by this keyword  "search": "Home"
sort
  • +/- id : will sort Ascending/Descending based on the generated ids for the system pages. Default is +id.
  • +/- alphabetical : will sort Ascending/Descending based on the names
  "sort": "+alphabetical"
language Will return system pages in the given language. If language code is not provided, then results will be shown in the user's language set in their user preferences.  "language": "en_US"

 

Example HTTP Request & Response

POST https://example.com/context/api/2/systempages

 

JSON Request

{
    "systempagesquery": {
        "user" : "mitul.patel@highq.com",
        "sort" : "+alphabetical",
        "language" : "fr_FR"
    }
}

JSON Response

{
    "total": 7,
    "totalcount": 7,
    "currentpage": 0,
    "systempages": [
        {
            "id": 1,
            "title": "Home_FR",
            "url": "https://example.com/context/Home"
        },
        {
            "id": 2,
            "title": "Parcourir",
            "url": "https://example.com/context/browse"
        },
        {
            "id": 4,
            "title": "People Directory",
            "url": "https://example.com/context/people-updated-link"
        },
        {
            "id": 5,
            "title": "Préférences des courriels",
            "url": "https://example.com/context/lstv_userProfile.action?Profiletype=0"
        },
        {
            "id": 6,
            "title": "Préférences du système",
            "url": "https://example.com/context/lstv_userProfile.action?Profiletype=1"
        },
        {
            "id": 3,
            "title": "Rechercher",
            "url": "https://example.com/context/search"
        },
        {
            "id": 7,
            "title": "Se connecter",
            "url": "https://example.com/context/LoginRequiredPage.action"
        }
    ]
}

 

XML Request

<systempagesquery>
    <user>mitul.patel@highq.com</user>
    <sort>+alphabetical</sort>
    <language>fr_FR</language>
</systempagesquery>

XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<systempages>
    <total>7</total>
    <totalcount>7</totalcount>
    <currentpage>0</currentpage>
    <systempage>
        <id>1</id>
        <title>Home_FR</title>
        <url>https://example.com/context/Home</url>
    </systempage>
    <systempage>
        <id>2</id>
        <title>Parcourir</title>
        <url>https://example.com/context/browse</url>
    </systempage>
    <systempage>
        <id>4</id>
        <title>People Directory</title>
        <url>https://example.com/context/people-updated-link</url>
    </systempage>
    <systempage>
        <id>5</id>
        <title>Préférences des courriels</title>
        <url>https://example.com/context/lstv_userProfile.action?Profiletype=0</url>
    </systempage>
    <systempage>
        <id>6</id>
        <title>Préférences du système</title>
        <url>https://example.com/context/lstv_userProfile.action?Profiletype=1</url>
    </systempage>
    <systempage>
        <id>3</id>
        <title>Rechercher</title>
        <url>https://example.com/context/search</url>
    </systempage>
    <systempage>
        <id>7</id>
        <title>Se connecter</title>
        <url>https://example.com/context/LoginRequiredPage.action</url>
    </systempage>
</systempages>

Validation Messages
Description Response Response Code
When offset is negative or not a number. <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>106</ref>
    <summary>Invalid parameter: offset</summary>
</error>		 400
When limit is not a positive number. <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>107</ref>
    <summary>Invalid parameter: limit</summary>
</error>		 400
When  user email passed in 'user' parameter that does not exists <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>108</ref>
    <summary>The requested user does not exist</summary>
</error>		 400
When  invalid language parameter is passed <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>144</ref>
    <summary>Invalid parameter: language</summary>
</error>		 400
When  invalid sort parameter is passed <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <ref>79</ref>
    <summary>Invalid parameter: sort</summary>
</error>		 400

 

Comments


0 Comments

Last Updated: Nov 08,2024