You can export a consumer definition as a csv file.
Execution permission
Admin
Request line
POST baseURL/v1/objects/GroupsDefinition/{id}/actions/export/invoke
Request body
The structure of the request body and the object attributes are 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. |
Response body
The structure of the response body is csv.
Status codes
|
Status code |
Reason phrase |
Description |
|---|---|---|
|
200 |
OK |
Success. |
|
400 |
Bad Request |
The format of the request body is invalid. |
|
401 |
Unauthorized |
No login privilege. |
|
403 |
Forbidden |
No execute privilege. |
|
412 |
Precondition Failed |
The server is not available. |
|
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header]
POST Analytics/v1/objects/GroupsDefinition/consumerDefinition%23786722c0-24c0-44ac-b436-cb4d4e52c564/actions/export/invoke
authorization:Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json,text/csv
Content-Type: application/json
[Request Body]
{
"name": "export",
"href": "http://localhost:22015/Analytics/v1/objects/GroupsDefinition/creationPlan%23786722c0-24c0-44ac-b436-cb4d4e52c564/actions/export/invoke",
"method": "POST",
"type": "application/json",
"parameters": []
}
[Response Header]
HTTP/1.1 200 OK
date: Fri, 01 Apr 2022 11:21:14 GMT
server: CosminexusComponentContainer
cache-control: no-cache, must-revalidate, private, max-age=0
content-disposition: attachment; filename="VOLUME_Host_Group_Name_PrecedeSeparator_Bronze_20220331190743.csv"; creation-date="Fri, 01 Apr 2022 11:21:14 GMT"
x-consumer-creation-plan-csv-filename: VOLUME_Host_Group_Name_PrecedeSeparator_Bronze_20220331190743.csv
access-control-expose-headers: X-Consumer-Creation-Plan-Csv-Filename, Content-Disposition
www-authenticate: HSSO 767c4dcc631df853945e2272f695555997d6804a_Wm0HGnlmckFqXXwA_V0810
content-type: text/csv
content-length: 288
x-frame-options: SAMEORIGIN
x-xss-protection: 1; mode=block
x-content-type-options: nosniff
content-security-policy: frame-ancestors 'self'
[Response Body]
"CONSUMER","GRADE","RESOURCE TYPE","ATTRIBUTE","CONDITION","VALUE","RULE NAME","RULE DESCRIPTION"
"_A_HostGroup","Bronze","Volume","Host Group Name","Starts with","HostGroup","_A_HostGroup_Host Group Name_Starts with","_A_Volume_Host Group Name_PrecedeSeparator_Bronze_System_20220331190743"