REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure (Hyperledger Fabric v2.5)

List Blockchain Platforms

get

/20191010/blockchainPlatforms

Returns a list Blockchain Platform instances in a compartment.

Request

Supported Media Types

application/json

Query Parameters

compartmentId(required): string

The ID of the compartment in which to list resources.
displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`
lifecycleState: string

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

Maximum Length: 2048

The page at which to start retrieving results.
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

The sort order to use, either 'ASC' for ascending or 'DESC' for decending.

Default Value: ASC

Allowed Values: [ "ASC", "DESC" ]

Header Parameters

opc-request-id: string

The client request ID for tracing.

Response

Supported Media Types

application/json

200 Response

Gets list of Blockchain Platform instances

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : BlockchainPlatformCollection

Type: object

Result of a platform list or search. Contains BlockchainPlatformSummary

Show Source

items(required): array items

Collection of BlockchainPlatformSummary

{
    "type":"object",
    "description":"Result of a platform list or search. Contains BlockchainPlatformSummary",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Collection of BlockchainPlatformSummary",
            "items":{
                "$ref":"#/definitions/BlockchainPlatformSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Collection of BlockchainPlatformSummary

Show Source

Array of: object BlockchainPlatformSummary

Blockchain Platform instance summary.

{
    "type":"array",
    "description":"Collection of BlockchainPlatformSummary",
    "items":{
        "$ref":"#/definitions/BlockchainPlatformSummary"
    }
}

Nested Schema : BlockchainPlatformSummary

Type: object

Blockchain Platform instance summary.

Show Source

compartmentId(required): string

Compartment identifier
computeShape(required): string

Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
description: string

Blockchain Platform instance description
displayName(required): string

Blockchain Platform instance display name. Can be renamed.
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
id(required): string

Unique identifier that is immutable on creation
lifecycleDetails: string

An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
lifecycleState: string

The current state of the Blockchain Platform instance.
platformRole: string

Role of platform: founder or participant
serviceEndpoint: string

Service endpoint URL, valid post-provisioning
timeCreated: string(date-time)

The time the the Blockchain Platform instance was created. An RFC3339 formatted datetime string.
timeUpdated: string(date-time)

The time the Blockchain Platform instance was updated. An RFC3339 formatted datetime string.

{
    "description":"Blockchain Platform instance summary.",
    "type":"object",
    "required":[
        "id",
        "compartmentId",
        "displayName",
        "computeShape"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation",
            "type":"string"
        },
        "displayName":{
            "description":"Blockchain Platform instance display name. Can be renamed.",
            "type":"string"
        },
        "compartmentId":{
            "description":"Compartment identifier",
            "type":"string"
        },
        "description":{
            "description":"Blockchain Platform instance description",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the the Blockchain Platform instance was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the Blockchain Platform instance was updated. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "platformRole":{
            "description":"Role of platform: founder or participant",
            "x-obmcs-enumref":"#/definitions/BlockchainPlatform/platformRole",
            "type":"string"
        },
        "computeShape":{
            "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.",
            "x-obmcs-enumref":"#/definitions/BlockchainPlatform/computeShape",
            "type":"string"
        },
        "serviceEndpoint":{
            "description":"Service endpoint URL, valid post-provisioning",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the Blockchain Platform instance.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/BlockchainPlatform/lifecycleState"
        },
        "lifecycleDetails":{
            "description":"An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
            "type":"string"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

500 Response

Service unavailable

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}