Jump to

• Request
• Response

Gets all the Fleet Patching and Provisioning Client clusters by Fleet Patching and Provisioning Server.

get

/rhp-restapi/rhp/clients/getByServer

Gets all the Fleet Patching and Provisioning Client clusters associated with the Fleet Patching and Provisioning Servers matching the regular expression given.

Request

Supported Media Types

• application/json

Query Parameters

• rhpserver: string
  Regular expression to match the cluster name of the servers where the operation must be executed.

Security

• basicAuthentication: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• text/html

200 Response

OK. A JSON object containing an "items" property populated with 0 or more elements with at least an Id property and the links array with at least the "self" link.

Body ()

Root Schema : arrayOfItems

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResource"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object singleResource

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

Nested Schema : singleResource

Type: object

Show Source

• links: array links
• resourceId: string

{
    "type":"object",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object singleResourceLinks

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

Nested Schema : singleResourceLinks

Type: object

Show Source

• href: string
  The referenced hyperlink element provided in an absolute format.
• rel: string
  Allowed Values: [ "self", "collection", "up", "describedBy" ]

  Specify the type of relationship the link has with the described resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "self",
                "collection",
                "up",
                "describedBy"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format."
        }
    }
}

Default Response

Unexpected error. A JSON object containing error details of the issue while executing the operation.

Body ()

Root Schema : errorResource

Type: object

Show Source

• errorCode: string
  Application specific error code, related to the error message shown at tittle.
• errorDetails: array errorDetails
  If multiple errors are reported they can be organized in a hierarchical structure in this array.
• errorPath: string
  XPath or JSON path to indicate where the error occurs.
• instance: string
  URI to the link that provides more detail about the error.
• status: integer
  HTTP status code.
• title: string
  Summary error message.
• type: string
  Link to HTTP error code page.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

Nested Schema : errorDetails

Type: array

If multiple errors are reported they can be organized in a hierarchical structure in this array.

Show Source

• Array of: object errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

Back to Top