2.7.3 Acquiring a List of Operations for the Custom Settings of a User

This API request acquires a list of operations that can be performed for the custom settings of a user.

Execution permission

User Management

API version

Request format

GET http[s]://host:port/Analytics/version/services/UserCustomSettings/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	Action[]	A list of Action objects. For details about Action, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions.

data (Type: Action)

Attribute	Type	Description
name	string	Name of the execute an operation.
href	string	URL of the execute an operation.
method	string	Name of the method.
type	string	Data format of the object.
parameters	anyType[]	A list of objects. No value is set.

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	page
pageSize	integer	Size of the pages
numPages	integer	Number of the pages
totalCount	integer	Number of the objects

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/UserCustomSettings/actions HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:36:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 38b785fe1f2c64401d1f55c39985a241d4e6079_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "clearUserCustomSetting",
    "href" : "http://JP1OAServer:22015/Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}