Show Operation¶
Summary¶
Get operation information and history of CIC.
Type¶
- Get
Target object of API¶
- Operation
Synchronous/Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{api_endpoint}/v1.0/ecc/operations/{operation_id}
HTTP Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>
HTTP Request Body¶
- none
Parameters¶
| name | style | format | description | required/optional | default value | action for invalid parameter | response code for invalid parameter |
|---|---|---|---|---|---|---|---|
| token_id | Header | authentication token string(varchar) | keystone authentication token | required | Terminate | 401 | |
| operation_id | URL | String(13) | It identifies operation uniquely. Operation ID is generated when customer offered create , update, and delete. | required | Terminate | 404 |
Response¶
Response Header¶
Format¶
HTTP/1.1 <response_code> <message> (ex. 200 OK)
<response_code>: see "HTTP Responses" section
<message>: message based on the response code
- skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"
Response Body¶
Format¶
{
"operation_id": "<operation id>",
"operation_status": "<operation status>",
"operation_type": "<operation type>",
"operation_body": {},
"mcic_id": "<mcic id>",
"cic_id": "<cic id>",
"user_id": "<user id>",
"user_name": "<user name>",
"reciept_date": "<date>",
"error_messages": ["<error message>","<error message>"]
}
Parameters¶
| item | format | description |
| operation_id | String | It identifies operation uniquely. Operation ID is generated when customer offered create , update, and delete. |
| operation_status | String | Status of operation. processing/success/failure are displayed. |
| operation_type | String | Type of operations. create/delete/update are displayed. |
| operation_body | Object | This object stored request body. |
| mcic_id | String | It identifies mCIC uniquely which corresponded to your processing. |
| cic_id | String | It identifies CIC uniquely which corresponded to your processing. |
| user_id | String | It identifies customer user uniquely which executed the operation. |
| user_name | String | Customer user name which executed the operation. |
| reciept_date | dateTime | The date when this API receipted operation. |
| error_messages | Array | This array stored error messages which responded from backend systems. |
Sample Request and Response¶
Sample API request¶
Request URI¶
http://{api_endpoint}/v1.0/ecc/operations/ECC0000000105
Request Header¶
Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4
Request Body¶
- none
Sample API response¶
Response Header¶
HTTP/1.1 200 OK
<response_code>: see "HTTP Responses" section
<message>: message based on the response code
- skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"
Response Body¶
{
"operation_id": "ECC0000000105",
"operation_status": "processing",
"operation_type": "create",
"operation_body": {},
"mcic_id": "CIC-JP-A0000000",
"user_id": "1234567",
"user_name": "joe",
"reciept_date": "2015-07-01 00:00:00"
"error_messages": [""]
}
or
{
"operation_id": "ECC0000000105",
"operation_status": "processing",
"operation_type": "create",
"operation_body": {},
"cic_id": "CIC-JP-A0000000-0001",
"user_id": "1234567",
"user_name": "joe",
"reciept_date": "2015-07-01 00:00:00"
"error_messages": [""]
}
Example error message¶
HTTP request¶
GET /v1.0/ecc/operations/ECC9999990000 HTTP/1.1
User-Agent: curl/7.37.1
Host: 192.168.150.71:9001
Content_type:application/json
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
HTTP Response¶
HTTP/1.1 404 HTTP 404: Not Found
Server: nginx/1.8.0
Date: Mon, 28 Sep 2015 09:32:41 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 59
Connection: keep-alive
{
"cause": "Could not found operation. ECC9999990000"
}