tags


URI

<portal_uri>/tags[.<format>]

Supported methods

GET, HEAD

Parent resource

portal

Introduction

tags resource is the tag query resource of map, service, scene, application, data and group.

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/tags.rjson

GET request

Get the tag query resource of map, service, scene, application, data and group.

Request parameter

If searchType isn't set, then the tag information of the map will be returned; if searchType has a value, the corresponding tag information of map, service, application, data or group will be returned, and the parameters have to be included in the URI.

Name Type Description
sourceTypes SourceType[] Filtered by source type.
joinTypes JoinType[] Filtered by group type.
keywords String[] Filtered by keywords.
userName String Filtered by user name.
searchType TagSearchType The tag query types, including Map, Service, Scene, App, Data, Group.
start Integer Query from the start record.
length Integer Return the number of tags.
authorizedOnly Boolean Filter according to whether the service is authorized. The default value is false, which indicates all the services will be returned; If it is true, only the authorized services will be returned. This parameter is valid only in service sharing v2 mode, which is used by default in iPortal.

Response structure

Execute GET request on tags resource, the returned individual tag representaion structure is as follows:

Field Type Description
tag String Tag name.
counts int The count of usage.

Response example

Execute GET request on tags http://localhost:8090/iportal/web/tags.rjson. By default, it gets all map tags and returns the resource representation with rjson format:

[

    {

        "counts": 2,

        "tag": "Shanghai"

    },

    {

        "counts": 1,

        "tag": "Beijing"

    },

    {

        "counts": 1,

        "tag": "Nautical Chart"

    }

]

You need to set userNames=admin&searchType=SERVICE if you want to get specified tag information and filtered by user name and tag type. In other words, the returned rjson format representation after implementing the GET request on the maps resource http://localhost:8090/iportal/web/tags.rjson?userName=admin&searchType=SERVICE is as follows:

[

    {

        "counts": 1,

        "tag": "WMS"

    }

]

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 tags resource exists, or if the tags resource can be accessed by clients. It can also determine if the tags resource supports an output format <format> if performed on a URI with .<format> included.

See