Jump to

• Request
• Response
• Examples

Gets a Page configuration or lists down immediate pages under requested page.

get

/gsadmin/v1/{appName}/pages/{siteHome}/{page}

Gets page configuration or a list of immediate pages defined under a page. If zip extension is specified (add ".zip" at the end of the path), all pages of the site are exported as a zip file.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• page: string
  Specifies the name of the page.
• siteHome: string
  Specifies the name of the site.

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

Gets a Page configuration or lists down immediate pages under requested page.

Body ()

Root Schema : Page

Type: object

Represents a page definition under a site

Show Source

• contentItem(optional): object ContentItemObject
• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: page

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"page"
        },
        "contentItem":{
            "description":"Defines a contentItem object",
            "$ref":"#/definitions/ContentItemObject"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents a page definition under a site "
}

Nested Schema : ContentItemObject

Type: object

Show Source

• @name(optional): string
• @type(optional): string

{
    "type":"object",
    "properties":{
        "@name":{
            "type":"string"
        },
        "@type":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to view the default page configuration:

curl -H "Authorization:Bearer <token>" -X GET http://host:port/gsadmin/v1/cloud/pages/Default/services/guidedsearch

Back to Top