Blockchain Platform Manager APIs

Get All Activity Details

get

/api/v1/blockchainPlatforms/activities

Get activity details for all instances.

Request

Query Parameters

fromDate: string

Lower bound of date range search criteria in format yyyy-MM-dd
instanceNameText: string

Instance name text to be used as a search criteria
operations: string

A comma separated list of operation types for which activities are to be retrieved
platformType: string

Optional activity platform filter. Only Besu activities are supported.

Allowed Values: [ "besu" ]
platformtype: string

Backward-compatible lowercase alias for `platformType`. When both are supplied, `platformType` takes precedence.

Allowed Values: [ "besu" ]
toDate: string

Higher bound of date range search criteria in format yyyy-MM-dd

Header Parameters

Authorization(required): string

Bearer access token. Supply as: Bearer .

Response

Supported Media Types

application/json

200 Response

Root Schema : InstanceActivityInfoSummary

Type: object

Activities for blockchain Platform Instance

Show Source

activities: array activities

List activities associated with the blockchain platform instance

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

Nested Schema : activities

Type: array

List activities associated with the blockchain platform instance

Show Source

Array of: object ActivityInfoSummary

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

Nested Schema : ActivityInfoSummary

Type: object

Show Source

details: string

Detail message from the latest status of the operation
initiatedBy: string

User who has initiated the activity
instanceId: string

Platform Instance ID
instanceName: string

Name of the Platform Instance
lastUpdatedTime: string(date-time)

Latest time when the operation status has been tracked
operation: string

Operation name
operationId: string

Operation ID
operationStartTime: string(date-time)

Time when the operation has started
operationStatus: 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 has started"
        },
        "lastUpdatedTime":{
            "type":"string",
            "format":"date-time",
            "description":"Latest time when the operation status has been tracked"
        },
        "initiatedBy":{
            "type":"string",
            "description":"User who has initiated the activity"
        },
        "details":{
            "type":"string",
            "description":"Detail message from the latest status of the operation"
        }
    }
}

400 Response

Bad Request

Root Schema : Error

Type: object

Error Information.

Show Source

errors: array errors

list of errors
message(required): string

A human-readable error string.
status(required): string

A short error status that defines the error, meant for programmatic parsing.
warnings: array warnings

list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

code(required): string

Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

code(required): string

Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

Error Information.

Show Source

errors: array errors

list of errors
message(required): string

A human-readable error string.
status(required): string

A short error status that defines the error, meant for programmatic parsing.
warnings: array warnings

list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}