Jump to

• Request
• Response

List Blockchain Platform OSNs

get

/20191010/blockchainPlatforms/{blockchainPlatformId}/osns

Lists all Blockchain Platform ordering service nodes (OSNs).

Request

Supported Media Types

• application/json

Path Parameters

• blockchainPlatformId: string
  Unique service identifier.

Query Parameters

• 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`
• 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: 1024

  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.
• opc-retry-token(optional): string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Gets list of Blockchain Platform OSNs

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.

Body ()

Root Schema : OsnCollection

Type: object

Result of a OSN list or search. Contains OsnSummary

Show Source

• items: array items
  Collection of OsnSummary

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

Nested Schema : items

Type: array

Collection of OsnSummary

Show Source

• Array of: object OsnSummary
  OSN summary information for returning in a list.

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

Nested Schema : OsnSummary

Type: object

OSN summary information for returning in a list.

Show Source

• lifecycleState(optional): string
  The current state of the OSN.
• osnKey(optional): string
  Minimum Length: 1

  Maximum Length: 255

  OSN identifier

{
    "type":"object",
    "description":"OSN summary information for returning in a list.",
    "properties":{
        "osnKey":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"OSN identifier"
        },
        "lifecycleState":{
            "description":"The current state of the OSN.",
            "x-obmcs-enumref":"#/definitions/Osn/lifecycleState",
            "type":"string"
        }
    }
}

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.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: 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.

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• code: string
  A short error code that defines the error, meant for programmatic parsing.
• message: 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"
        }
    }
}

Back to Top