Jump to

• Request
• Response
• Examples

List Blockchain Platform Patch Targets

get

/api/v1/blockchainPlatforms/patches/{patchId}/targets

List Blockchain Platform patch targets.

Request

Supported Media Types

• application/json

Path Parameters

• patchId: string
  Unique patch identifier

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PatchTargetInfo

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PatchTargetInfo"
    }
}

Nested Schema : PatchTargetInfo

Type: object

Show Source

• instanceId(optional): string
  Target instance ID
• instanceName(optional): string
  Target instance display name
• status(optional): string
  Target instance status
• timeCreated(optional): string
  Target instance creation date
• version(optional): string
  Target instance version

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Target instance ID"
        },
        "instanceName":{
            "type":"string",
            "description":"Target instance display name"
        },
        "version":{
            "type":"string",
            "description":"Target instance version"
        },
        "status":{
            "type":"string",
            "description":"Target instance status"
        },
        "timeCreated":{
            "type":"string",
            "description":"Target instance creation date"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

500 Response

Service unavailable

Default Response

Unknown Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors(optional): array errors
  list of errors
• message: string
  A human-readable error string.
• status: string
  A short error status that defines the error, meant for programmatic parsing.
• warnings(optional): 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"
    }
}

Back to Top

Examples

This endpoint is used to get the list of Blockchain Platform patch target instances.

The following example shows how to query and get the list of Blockchain Platform patch targets instances by submitting a GET request on the REST resource using cURL:

curl -X GET http://<hostname>:<port>/api/v1/blockchainPlatforms/patches/obp-patch-19-3-3/targets 
-H 'Authorization: Basic amFzc2l0ZXN0OndlbGNvbWUx

Example of the Response Body

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

[ {
  "instanceId" : "56cda494-e776-416e-a2fa-c7e2a95955b8",
  "instanceName" : "JasFounder",
  "version" : "19.3.2",
  "status" : "Healthy",
  "timeCreated" : "2019-08-30 10:11:26.169"
} ]

Back to Top