URI

<portal_uri>/permissions/highestpermission[.<format>]

Supported Methods

GET, HEAD

Parent Resource

portal

Description

The highestPermission resource represents the highest permission that the current user has on one or more resources of a specified resource type.

Supported Methods:

  • GET: Get the highest permission that the current user has on one or more specific resources of the specified type.
  • HEAD: Check whether the highestPermission resource exists or whether the permissions allow access to the highestPermission resource.

Supported output formats: RJSON, JSON, XML.

Resource hierarchy

HTTP Request Methods

Perform HTTP requests on the following URI. The rjson output format is used as an example, where supermapiportal is the server name.

http://supermapiportal:8190/iportal/web/permissions/highestpermission.rjson

GET Request

Get the highest permission that the current user has on one or more specific resources of the specified type.

Request Parameters

When sending a request, the following parameters must be included. The request parameters must be included in the URI.

Name Type Description
resourceType ResourceType The type of the resource.
resourceIds List<Integer> The collection of resource IDs.

Response Structure

Perform a GET request on the highestPermission resource. The returned representation structure of the highest permission for a single resource is as follows:

Field Type Description
id Integer The ID of the resource.
permission PermissionType The highest permission the current user has on this resource. Includes SEARCH (searchable), READ (readable), READWRITE (editable), DELETE (deletable).

Response Example

Perform a GET request on the highestPermission resource: http://localhost:8190/iportal/web/permissions/highestpermission.rjson?resourceType=MAP&resourceIds=[25,36,48] to get the highest permissions the current user has on three map resources with IDs 25, 36, and 48. The rjson format response is as follows:

{

  "36": "READWRITE",

  "25": "READ",

  "48": "SEARCH"

}

HEAD Request

Returns the same HTTP response headers as the GET request, but without the response entity. Metadata information contained in the response headers can be retrieved without transferring the entire response content. Metadata information includes media type, character encoding, compression encoding, entity content length, etc.

A HEAD request can be used to check whether the highestPermission resource exists or whether the client has permission to access the highestPermission resource. By performing a HEAD request on the URI with .<format> appended, you can also quickly determine whether the highestPermission resource supports the <format> format representation.

See