Jump to

• Request
• Response
• Examples

Get Instance Activity Details

get

/api/v1/blockchainPlatforms/instances/{id}/activity

Get activity details for an instance.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Unique platform instance identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : InstanceActivityInfoSummary

Type: object

Activities for a Blockchain Platform Instance

Show Source

• activities(optional): array activities
  List activities associated with a blockchain platform instance

{
    "description":"Activities for a Blockchain Platform Instance",
    "type":"object",
    "properties":{
        "activities":{
            "description":"List activities associated with a blockchain platform instance",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActivityInfoSummary"
            }
        }
    }
}

Nested Schema : activities

Type: array

List activities associated with a blockchain platform instance

Show Source

• Array of: object ActivityInfoSummary

{
    "description":"List activities associated with a blockchain platform instance",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ActivityInfoSummary"
    }
}

Nested Schema : ActivityInfoSummary

Type: object

Show Source

• details(optional): string
  Detailed message from the latest status of the operation
• initiatedBy(optional): string
  User who initiated the activity
• instanceId(optional): string
  Platform instance ID
• instanceName(optional): string
  Name of the platform instance
• lastUpdatedTime(optional): string(date-time)
  Most recent time when the operation status was tracked
• operation(optional): string
  Operation name
• operationId(optional): string
  Operation ID
• operationStartTime(optional): string(date-time)
  Time when the operation started
• operationStatus(optional): string
  Operation status

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Platform instance ID"
        },
        "instanceName":{
            "type":"string",
            "description":"Name of the platform instance"
        },
        "operation":{
            "type":"string",
            "description":"Operation name"
        },
        "operationId":{
            "type":"string",
            "description":"Operation ID"
        },
        "operationStatus":{
            "type":"string",
            "description":"Operation status"
        },
        "operationStartTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the operation started"
        },
        "lastUpdatedTime":{
            "type":"string",
            "format":"date-time",
            "description":"Most recent time when the operation status was tracked"
        },
        "initiatedBy":{
            "type":"string",
            "description":"User who initiated the activity"
        },
        "details":{
            "type":"string",
            "description":"Detailed message from the latest status of the operation"
        }
    }
}

401 Response

Not authorized

404 Response

Invalid parameters

500 Response

Service unavailable

Back to Top

Examples

This endpoint is used to get the details of all the activities of performed on a particular Blockchain Platform instance.

The following example shows how to query and get the details of all the activities performed on a particular Blockchain Platform instance.

curl -X GET \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/9956c203-5182-4db1-bcf1-9f34e1df29c8/activity \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json'

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "activities": [
    {
      "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
      "instanceName": "myNATinstf1",
      "operation": "Scaleout",
      "operationId": "IDxp769lEAPEz7Ch2ntj94P0-xeFubY87wh3dQzr88k1Q=",
      "operationStatus": "successful",
      "operationStartTime": 1567562162133,
      "lastUpdatedTime": 1567562238677,
      "initiatedBy": "obpuser",
      "details": "Operation successful."
    },
    {
      "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
      "instanceName": "myinstance",
      "operation": "Scalein",
      "operationId": "IDxUl_j7o3Ayqi6wJfNBpBpDrijePWoXgwy9pljmqkZ_k=",
      "operationStatus": "successful",
      "operationStartTime": 1567559363488,
      "lastUpdatedTime": 1567559428821,
      "initiatedBy": "obpuser",
      "details": "Operation successful."
    },
    {
      "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
      "instanceName": "myinstance",
      "operation": "Create",
      "operationId": "IDGacTFUlm0wfhjpkYP2inLAhcJrO8D2muFAHMJT9HiOg=",
      "operationStatus": "successful",
      "operationStartTime": 1567556931932,
      "lastUpdatedTime": 1567557797289,
      "initiatedBy": "obpuser",
      "details": "Operation successful."
    }
  ]
}

Back to Top