portal


URI

http://<server>:<port>/iportal/web[.<format>]

Supported methods

GET, HEAD

Child resources

login, users, maps, services, tags, myContent

Introduction

The portal resource is the root node of REST service in SuperMap iPortal. It is an entrance to all portal services. The portal resources and their sub resources are only available in iPortal.

While service security has been enabled, logging or Token authentication are needed to access operations like online mapping, registering, clustering management, and access protected services like contents, service manager. Authentication information needs to be carried while accessing resource in the REST method. For example, Cookie information generated while logging in HTTP Form-based Authentication can be carried in the HTTP request head, or you can Access Protected REST Service Resources based on Token. Cookie information can be acquired whiling logging and Token can acquired through the token resource.

Supported Methods:

Supported formats: rjson, json, html, xml.

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiportal is the server name, with rjson being the output format.

http://supermapiportal:8090/iportal/web.rjson

GET request

Get the representation of portal resource, i.e., the entrance to current service.

Request parameter

GET request in portal resource is a resource descriptive collection in the entity of response messaging, where the structure of a single resource description is as follows:

Field Type Description
name String Resource name
path String Resource URL.
resourceConfigID String The configuration item ID of the resource.
resourceType String The resource type.
supportedMediaTypes String[] The media-type of the supported representation.

Response example

The returned rjson format representation after implementing the GET request on the portal resource http://localhost:8090/iportal/web.rjson is as follows:

[

    {

        "name": "login",

        "path": "http://localhost:8090/iportal/web/login",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "users",

        "path": "http://localhost:8090/iportal/web/users",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "tags",

        "path": "http://localhost:8090/iportal/web/tags",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "maps",

        "path": "http://localhost:8090/iportal/web/maps",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "services",

        "path": "http://localhost:8090/iportal/web/services",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "datas",

        "path": "http://localhost:8090/iportal/web/datas",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "mycontent",

        "path": "http://localhost:8090/iportal/web/mycontent",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "groups",

        "path": "http://localhost:8090/iportal/web/groups",

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    }

]

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check if the portal resource exists, or if the portal resource can be accessed by clients. It can also determine if the portal resource supports an output format <format> if performed on a URI with .<format> included.

See