Jump to

• Request
• Response
• Examples

Register a New Blockchain Platform Patch

post

/api/v1/blockchainPlatforms/patches

Register a new Blockchain Platform patch.

Request

Supported Media Types

• multipart/form-data

Form Parameters

• patchArchive: string
  A tar archive file containing patch details - metadata.json scripts/prePatch.sh scripts/postPatch.sh .tgz for each component.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : PatchInfoSummary

Type: object

Show Source

• applicable(optional): boolean
  Is patch able to be applied
• description(optional): string
  Patch description or details
• displayName(optional): string
  Patch display name
• fullVersion(optional): string
  Patch full version
• patchId(optional): string
  Patch ID
• prevVersion(optional): string
  Previous version
• release(optional): string
  Patch release version
• rollbackable(optional): boolean
  Is patch able to be rolled back
• serviceVersion(optional): string
  Patch service version
• status(optional): string
  Patch/rollback status

{
    "type":"object",
    "properties":{
        "patchId":{
            "type":"string",
            "description":"Patch ID"
        },
        "displayName":{
            "type":"string",
            "description":"Patch display name"
        },
        "description":{
            "type":"string",
            "description":"Patch description or details"
        },
        "serviceVersion":{
            "type":"string",
            "description":"Patch service version"
        },
        "release":{
            "type":"string",
            "description":"Patch release version"
        },
        "fullVersion":{
            "type":"string",
            "description":"Patch full version"
        },
        "prevVersion":{
            "type":"string",
            "description":"Previous version"
        },
        "rollbackable":{
            "type":"boolean",
            "description":"Is patch able to be rolled back"
        },
        "applicable":{
            "type":"boolean",
            "description":"Is patch able to be applied"
        },
        "status":{
            "type":"string",
            "description":"Patch/rollback status"
        }
    }
}

400 Response

Bad Request

401 Response

Not authorized

409 Response

Operation conflict

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"
    }
}

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 register a new Blockchain Platform patch.

The following example shows how to query and register a new Blockchain Platform patch by submitting a POST request on the REST resource using cURL

curl -X POST http://<hostname>:<port>/api/v1/blockchainPlatforms/patches 
-H 'Authorization: Basic amFzc2l0ZXN0OndlbGNvbWUx' 
-F patchArchive=@/home/oracle/obp-19-3-3.zip

Example of the Response Body

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

{
  "patchId" : "obp-patch-19-3-3",
  "displayName" : "OBP Patch 19.3.3",
  "description" : "OBP Patch 19.3.3",
  "serviceVersion" : "19.3",
  "release" : "3",
  "fullVersion" : "19.3.3",
  "prevVersion" : null,
  "rollbackable" : null,
  "applicable" : null,
  "status" : null
}

Back to Top