You can register a consumer definition csv file.
Execution permission
Admin
Request line
POST baseURL/v1/services/GroupsDefinition/actions/register/invoke
Request body
Specify consumer definition csv file.
Response body
The structure of the response body and the object attributes is as follows:Job
{
"instanceID":"...",
"created":"...",
"updated":"...",
"completed":"...",
"state":"...",
"affectedResource":["...", ...],
"result":["...", ...]
}
Job (Type: Job)
|
Attribute |
Type |
Description |
|---|---|---|
|
instanceID |
string |
ID of the Instance. |
|
created |
string |
Date the object is generated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00). |
|
updated |
string |
Time the object is updated in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00). |
|
completed |
string |
Time the processing completed in "yyyy-mm-ddThh:mm:ss.mmmTZD" format (e.g., 2017-08-25T20:07:39.472+09:00). |
|
state |
string |
One of the following values is set: "failed": The operation failed. "success": The operation completed successfully. |
|
affectedResource |
string[] |
A blank space is set. |
|
result |
anyType[] |
A list of objects. No value is set. |
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/services/GroupsDefinition/actions/register/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: multipart/form-data;
[Response Header]
HTTP/1.1 200
Date: Fri, 01 Apr 2022 12:20:29 GMT
Server: CosminexusComponentContainer
Cache-Control: no-cache, must-revalidate, private, max-age=0
WWW-Authenticate: HSSO eaab59c82e6b46e139979fab8b8431dd2e8c671a_Wm0HGnlmckFqXXwA_V0810
Content-Type: application/json
Content-Length: 480
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: frame-ancestors 'self'
[Response Body]
{ [480 bytes data]
100 1183 100 480 100 703 1660 2432 --:--:-- --:--:-- --:--:-- 4107{
"instanceID" : "fece0b00-ba69-4e34-8d33-3cd19950e394",
"created" : "2022-04-01T05:20:29.558-07:00",
"updated" : "2022-04-01T05:20:29.558-07:00",
"completed" : "2022-04-01T05:20:29.558-07:00",
"state" : "success",
"affectedResource" : [ "http://localhost:22015/Analytics/v1/objects/GroupsDefinition/consumerDefinition%2364c0f284%2db22f%2d41ae%2db493%2dee8a47041d35" ],
"result" : [ {
"instanceID" : "consumerDefinition#64c0f284-b22f-41ae-b493-ee8a47041d35"
} ]
}