You can get request information to preview a result of consumer auto creation for a consumer definition.
Execution permission
Admin
Request line
GET baseURL/v1/objects/GroupsDefinition/{id}/actions/preview
Request body
Not applicable.
Response body
The structure of the response body and the object attributes is as follows:Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
Attribute |
Type |
Description |
|---|---|---|
|
name |
string |
Name of the action. |
|
href |
string |
URL for the action. |
|
method |
string |
Name of the method. |
|
type |
string |
Data format for the object. |
|
parameters |
anyType[] |
A list of objects necessary to execute an operation. No value is set. |
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/objects/GroupsDefinition/consumerDefinition%23786722c0-24c0-44ac-b436-cb4d4e52c564/actions/preview
authorization:
Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json
[Response Header]
HTTP/1.1 200 OK
date: Fri, 01 Apr 2022 02:12:27 GMT
server: CosminexusComponentContainer
cache-control: no-cache, must-revalidate, private, max-age=0
www-authenticate: HSSO 2e5791f57e4474325f13e1d36ab6c7f5409519_Wm0HGnlmckFqXXwA_V0810
content-type: application/json
content-length: 265
x-frame-options: SAMEORIGIN
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
content-security-policy: frame-ancestors 'self'
[Response Body]
{
"name" : "preview",
"href" : "http://localhost:22015/Analytics/v1/objects/GroupsDefinition/consumerDefinition%23786722c0%2d24c0%2d44ac%2db436%2dcb4d4e52c564/actions/preview/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ ]
}