batchRegister


URI

<services_uri>/batchregister[.<format>]

Supported methods

POST

Parent resource

services

Child resources

batchRegisterRate

Introduction

Register services in a batch. Users with built-in admin roles have the permisssion to perform service batch registration operation. Starting with SuperMap iPortal 8C SP2 and later versions, users with service resource management rights also have the ability to register services in a batch.

Supported Methods:

Supported output formats: RJSON, JSON, HTML, XML.

Resource hierarchy

HTTP request methods

Execute HTTP request on the following URI, here we take rjosn as the output format as an example. Where, supermapiserver is the server name.

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

POST request

Registers services in a batch.

Request parameter

To execute a POST request on batchRegister resource, the fields included in request body should contain:

Name Type Description
rootUrl String The root address for the batch registration. e.g., http://ip:port/contextpath/
authorizeSetting List<IportalAuthorizeEntity> Sharing settings for batch registration.
status ServiceRootUrlStatus The hosted status. Used to indicate whether the iPortal will havest the batch registered services, for example, a new service is added into the iServer service list, or one service is stopped.
tags List<String> The tages of the services added in bulk.

Response structure

The structure of the returned response resource representation is as follows:

Field Type Description
succeed boolean Whether the batch registration operation succeeded.
newResourceID String The ID of the new registered resource.
newResourceLocation String The URL of the new registered resource.

Response example

Execute a POST request on batchRegister resource http://localhost:8090/iportal/web/services/batchregister.rjson with the request body as below:

{

    "rootUrl": "http://rdc.ispeco.com:8080/iserver/services",

    "authorizeSetting": [],

    "status": "UNHOSTING",

    "tags": [

        "User's service"

    ]

}

The returned result in rjson format is as follows:

    "newResourceID": "782cda16-e7b0-4011-b3fc-6cfc9b02316e",

    "succeed": true,

    "newResourceLocation": "/web/services/batchregister/782cda16-e7b0-4011-b3fc-6cfc9b02316e"

}

See