Operation - Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
Operaion is the user's resource operation history.
Get Operation
Get Operation resources.
Authorizations:
query Parameters
id | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the operaion. |
resourceId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The resource ID for the operation. |
serviceGroupId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Service Group to which the resource belongs. |
resourceType | string A type of resource the operation applied. |
status | string Enum: "PROCESSING" "COMPLETE" "ERROR" "STUCK" A status of the operation. |
requestType | string Enum: "CREATE" "DELETE" "UPDATE" A request type of the operation. |
limit | integer [ 1 .. 100 ] The maximum number of operations to return. |
offset | integer >= 0 The number of operations to skip before starting to return the operations. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
get/v1/operations
https://api.ntt.com/fsec-ers/v1/operations
Response samples
- 200
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "operations": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "resourceType": "ServiceGroup",
- "requestType": "UPDATE",
- "requestBody": "{\"serviceGroup\": {\"name\": \"service-group-1\"}",
- "responseBody": "{\"serviceGroup\": {\"name\": \"service-group-1\"}",
- "receptionTime": "2021-07-28T05:12:00Z",
- "commitTime": "2021-07-28T05:12:00Z",
- "warnings": [ ],
- "error": "",
- "status": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a3",
- "tenantId": "1234567890abcdef1234567890abcdef"
}, - {
- "id": "12345678-1234-1234-1234-1234567890b1",
- "resourceId": "12345678-1234-1234-1234-1234567890b2",
- "resourceType": "ServiceGroup",
- "requestType": "CREATE",
- "requestBody": "{\"serviceGroup\": {\"name\": \"service-group-2\"}",
- "responseBody": "{\"serviceGroup\": {\"name\": \"service-group-2\"}",
- "receptionTime": "2021-07-28T05:12:00Z",
- "commitTime": "2021-07-28T05:12:00Z",
- "warnings": [ ],
- "error": "",
- "status": "PROCESSING",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b3",
- "tenantId": "1234567890abcdef1234567890abcdef"
}
]
}
Get Operation
Get Operation resource.
Authorizations:
path Parameters
operation_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
get/v1/operations/{operation_id}
https://api.ntt.com/fsec-ers/v1/operations/{operation_id}
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "operation": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "resourceType": "ServiceGroup",
- "requestType": "UPDATE",
- "requestBody": "{\"serviceGroup\": {\"name\": \"service-group-1\"}",
- "responseBody": "{\"serviceGroup\": {\"name\": \"service-group-1\"}",
- "receptionTime": "2021-07-28T05:12:00Z",
- "commitTime": "2021-07-28T05:12:00Z",
- "warnings": [ ],
- "error": "",
- "status": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a3",
- "tenantId": "1234567890abcdef1234567890abcdef"
}
}