URI

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

Supported methods

GET, HEAD

Child resources

login, users, maps, services, scenes, apps, datas, directories, groups, tags, myContent, imageFileUpload, application, administrativeDivRegion, highestPermission, config, uiConfig, notebooks, feedbackInfos, newsInfos, webPrinting

Introduction

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

To access operations such as registered services and group management in SuperMap iPortal, as well as protected pages like My Resources and Service Manager, login or Token-based authentication is required. When accessing via REST, verification information needs to be carried. For example, you can carry the Cookie information generated during HTTP Form-based Authentication in the HTTP request header, or you can access protected REST service resources based on Token. Cookie information can be obtained during login, and Token can be acquired through the token resource.

Supported Methods:

  • GET: Get the representation of the portal resource, i.e., the entrance to the current service.
  • HEAD: Check whether the portal resource exists or whether you have permission to access the portal resource.

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:8190/iportal/web.rjson

GET request

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

Request parameter

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

Field Type Description
name String Resource name.
path String Resource access path.
resourceConfigID String The configuration item ID of the resource.
resourceType String The resource type.
supportedMediaTypes String[] The media types of the supported representations.

Response example

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

[

    {

        "name": "login",

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

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "users",

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

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "tags",

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

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "maps",

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

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "services",

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

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "datas",

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

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "mycontent",

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

        "resourceConfigID": null,

        "resourceType": null,

        "supportedMediaTypes": null

    },

    {

        "name": "groups",

        "path": "http://localhost:8190/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 client has permission to access the portal resource. It can also quickly determine if the portal resource supports the <format> representation by performing a HEAD request on a URI with .<format> included.

See