Jump to

• Request
• Response

Report of Patch Compliance for Subscribed Targets

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/targetsPatchComplianceReport

Patch compliance report for all subcribed targets

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• excludeList: array excludeList
  exclude the given details in response
• limit: number
  limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)

  Example: 10
• page: string
  Base 64 encoded page

  Example: b2Zmc2V0OjA
• sort: string
  Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName','targetType', 'hostName', 'release', 'platform','imageName','imageVersionName','imageVersionDescription','targetStatus', 'clusterName', 'additionalPatchCount', 'currentVersionName', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.

  Example: name:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsPatchComplianceReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName','targetType', 'hostName', 'release', 'platform','imageName','imageVersionName','imageVersionDescription','targetStatus', 'clusterName', 'additionalPatchCount', 'currentVersionName', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "enum":[
                    "total"
                ]
            }
        }
    }
}

Match All

Show Source

• object TargetsPatchComplianceReportFilter
  Filters for the subscribed targets compliance report

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetsPatchComplianceReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName','targetType', 'hostName', 'release', 'platform','imageName','imageVersionName','imageVersionDescription','targetStatus', 'clusterName', 'additionalPatchCount', 'currentVersionName', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"name:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "enum":[
                    "total"
                ]
            }
        }
    }
}

Nested Schema : excludeList

Type: array

exclude the given details in response

Show Source

• Array of:
  Allowed Values: [ "total" ]

{
    "description":"exclude the given details in response",
    "type":"array",
    "items":{
        "enum":[
            "total"
        ]
    }
}

Nested Schema : TargetsPatchComplianceReportFilter

Type: object

Filters for the subscribed targets compliance report

Show Source

• imageId: string
  ID of the image

  Example: E77FC170F57D4B64E0531D0E4B64DA85
• imageNameMatches: string
  Wildcard search on the image name

  Example: %img%
• isOnCurrentImage: boolean
  Patchlevel of the target (true-target is patched to the current image, false-target is patched to non-current image)
• platform: string
  Platform of the target

  Example: linux_x64_86
• releaseMatches: string
  Wildcard search on the release of the target

  Example: 19.14%
• targetNameMatches: string
  Wildcard search on the target name

  Example: %orcl%
• targetProperties: object targetProperties
  Propeties of target
• targetTypeList: array targetTypeList
  List of target types

{
    "description":"Filters for the subscribed targets compliance report",
    "type":"object",
    "properties":{
        "targetTypeList":{
            "description":"List of target types",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "targetProperties":{
            "description":"Propeties of target",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TargetPropertyFilter"
                }
            ],
            "type":"object"
        },
        "targetNameMatches":{
            "description":"Wildcard search on the target name",
            "type":"string",
            "example":"%orcl%"
        },
        "imageId":{
            "description":"ID of the image",
            "type":"string",
            "example":"E77FC170F57D4B64E0531D0E4B64DA85"
        },
        "imageNameMatches":{
            "description":"Wildcard search on the image name",
            "type":"string",
            "example":"%img%"
        },
        "releaseMatches":{
            "description":"Wildcard search on the release of the target",
            "type":"string",
            "example":"19.14%"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"linux_x64_86"
        },
        "isOnCurrentImage":{
            "description":"Patchlevel of the target (true-target is patched to the current image, false-target is patched to non-current image)",
            "type":"boolean"
        }
    }
}

Nested Schema : targetProperties

Type: object

Propeties of target

Match All

Propeties of target

Show Source

• object TargetPropertyFilter
  Target property filters

{
    "description":"Propeties of target",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPropertyFilter"
        }
    ],
    "type":"object"
}

Nested Schema : targetTypeList

Type: array

List of target types

Show Source

• Array of:
  Allowed Values: [ "oracle_database", "rac_database", "cluster", "has" ]

{
    "description":"List of target types",
    "type":"array",
    "items":{
        "enum":[
            "oracle_database",
            "rac_database",
            "cluster",
            "has"
        ]
    }
}

Nested Schema : TargetPropertyFilter

Type: object

Target property filters

Show Source

• contactList: array contactList
  List of contacts
• costCenterList: array costCenterList
  List of cost centers
• departmentList: array departmentList
  List of departments
• downtimeContactList: array downtimeContactList
  List of downtime contacts
• lifecycleStatusList: array lifecycleStatusList
  List of lifecyclestatus
• lineOfBusinessList: array lineOfBusinessList
  List of line of business
• locationList: array locationList
  List of locations
• siteList: array siteList
  List of sites

{
    "description":"Target property filters",
    "type":"object",
    "properties":{
        "contactList":{
            "description":"List of contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "downtimeContactList":{
            "description":"List of downtime contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costCenterList":{
            "description":"List of cost centers",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "departmentList":{
            "description":"List of departments",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lineOfBusinessList":{
            "description":"List of line of business",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "locationList":{
            "description":"List of locations",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteList":{
            "description":"List of sites",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStatusList":{
            "description":"List of lifecyclestatus",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : contactList

Type: array

List of contacts

Show Source

• Array of: string

{
    "description":"List of contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : costCenterList

Type: array

List of cost centers

Show Source

• Array of: string

{
    "description":"List of cost centers",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : departmentList

Type: array

List of departments

Show Source

• Array of: string

{
    "description":"List of departments",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : downtimeContactList

Type: array

List of downtime contacts

Show Source

• Array of: string

{
    "description":"List of downtime contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : lifecycleStatusList

Type: array

List of lifecyclestatus

Show Source

• Array of: string

{
    "description":"List of lifecyclestatus",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : lineOfBusinessList

Type: array

List of line of business

Show Source

• Array of: string

{
    "description":"List of line of business",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : locationList

Type: array

List of locations

Show Source

• Array of: string

{
    "description":"List of locations",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : siteList

Type: array

List of sites

Show Source

• Array of: string

{
    "description":"List of sites",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example Filter on Target properties

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. Target details retrieved.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object GoldImageSubscribedTargetsPatchComplianceReport
  Target details

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageSubscribedTargetsPatchComplianceReport"
        }
    ]
}

Nested Schema : GoldImageSubscribedTargetsPatchComplianceReport

Type: object

Target details

Show Source

• count: number
  count of subscribed targets in the current fetch

  Example: 10
• currentPage: string
  Base 64 encoded current page

  Example: b2Zmc2V0OjA
• items: array items
  list of targets
• nextPage: string
  Base 64 encoded next page

  Example: b2Zmc2V0OjA
• previousPage: string
  Base 64 encoded previous page

  Example: b2Zmc2V0OjA
• total: number
  Total count of targets subscribed to images

  Example: 100

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "total":{
            "description":"Total count of targets subscribed to images",
            "type":"number",
            "example":100
        },
        "count":{
            "description":"count of subscribed targets in the current fetch",
            "type":"number",
            "example":10
        },
        "items":{
            "description":"list of targets",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetPatchComplianceDetails"
                    }
                ],
                "properties":{
                    "imageId":{
                        "description":"Id of the image",
                        "type":"string",
                        "example":"E77FC170F57D4B64E0531D0E4B64DA85"
                    },
                    "imageName":{
                        "description":"name of the image",
                        "type":"string",
                        "example":"Tier1 SI 19.14"
                    },
                    "isImageUptodate":{
                        "description":"Flag to indicate if the image is uptodate",
                        "type":"boolean"
                    },
                    "imageVersionName":{
                        "description":"name of the image version",
                        "type":"string",
                        "example":"Version-1"
                    },
                    "imageVersionDescription":{
                        "description":"description of the image version",
                        "type":"string",
                        "example":""
                    },
                    "isCurrentImage":{
                        "description":"Flag indicates if the image is current version",
                        "type":"boolean"
                    },
                    "isNonCurrentVersionUptodate":{
                        "description":"Flag indicates if there is a uptodate image version",
                        "type":"boolean"
                    },
                    "patchCompliance":{
                        "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
                        "type":"string",
                        "example":"DRIFTED"
                    },
                    "currentVersionName":{
                        "description":"Name of the 'CURRENT' image version",
                        "type":"string",
                        "example":"19DBRU15"
                    },
                    "additionalPatchCount":{
                        "description":"Count of additional patches in target not present in image and are not not recommended patches",
                        "type":"integer",
                        "example":2
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of targets

Show Source

• Array of: object items

{
    "description":"list of targets",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetPatchComplianceDetails"
            }
        ],
        "properties":{
            "imageId":{
                "description":"Id of the image",
                "type":"string",
                "example":"E77FC170F57D4B64E0531D0E4B64DA85"
            },
            "imageName":{
                "description":"name of the image",
                "type":"string",
                "example":"Tier1 SI 19.14"
            },
            "isImageUptodate":{
                "description":"Flag to indicate if the image is uptodate",
                "type":"boolean"
            },
            "imageVersionName":{
                "description":"name of the image version",
                "type":"string",
                "example":"Version-1"
            },
            "imageVersionDescription":{
                "description":"description of the image version",
                "type":"string",
                "example":""
            },
            "isCurrentImage":{
                "description":"Flag indicates if the image is current version",
                "type":"boolean"
            },
            "isNonCurrentVersionUptodate":{
                "description":"Flag indicates if there is a uptodate image version",
                "type":"boolean"
            },
            "patchCompliance":{
                "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
                "type":"string",
                "example":"DRIFTED"
            },
            "currentVersionName":{
                "description":"Name of the 'CURRENT' image version",
                "type":"string",
                "example":"19DBRU15"
            },
            "additionalPatchCount":{
                "description":"Count of additional patches in target not present in image and are not not recommended patches",
                "type":"integer",
                "example":2
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• additionalPatchCount: integer
  Count of additional patches in target not present in image and are not not recommended patches

  Example: 2
• currentVersionName: string
  Name of the 'CURRENT' image version

  Example: 19DBRU15
• imageId: string
  Id of the image

  Example: E77FC170F57D4B64E0531D0E4B64DA85
• imageName: string
  name of the image

  Example: Tier1 SI 19.14
• imageVersionDescription: string
  description of the image version

  Example:
• imageVersionName: string
  name of the image version

  Example: Version-1
• isCurrentImage: boolean
  Flag indicates if the image is current version
• isImageUptodate: boolean
  Flag to indicate if the image is uptodate
• isNonCurrentVersionUptodate: boolean
  Flag indicates if there is a uptodate image version
• patchCompliance: string
  Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or - on which the target is patched

  Example: DRIFTED

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPatchComplianceDetails"
        }
    ],
    "properties":{
        "imageId":{
            "description":"Id of the image",
            "type":"string",
            "example":"E77FC170F57D4B64E0531D0E4B64DA85"
        },
        "imageName":{
            "description":"name of the image",
            "type":"string",
            "example":"Tier1 SI 19.14"
        },
        "isImageUptodate":{
            "description":"Flag to indicate if the image is uptodate",
            "type":"boolean"
        },
        "imageVersionName":{
            "description":"name of the image version",
            "type":"string",
            "example":"Version-1"
        },
        "imageVersionDescription":{
            "description":"description of the image version",
            "type":"string",
            "example":""
        },
        "isCurrentImage":{
            "description":"Flag indicates if the image is current version",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag indicates if there is a uptodate image version",
            "type":"boolean"
        },
        "patchCompliance":{
            "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
            "type":"string",
            "example":"DRIFTED"
        },
        "currentVersionName":{
            "description":"Name of the 'CURRENT' image version",
            "type":"string",
            "example":"19DBRU15"
        },
        "additionalPatchCount":{
            "description":"Count of additional patches in target not present in image and are not not recommended patches",
            "type":"integer",
            "example":2
        }
    }
}

Match All

Show Source

• object allOf TargetPatchComplianceDetails
  Target details

{
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPatchComplianceDetails"
        }
    ],
    "properties":{
        "imageId":{
            "description":"Id of the image",
            "type":"string",
            "example":"E77FC170F57D4B64E0531D0E4B64DA85"
        },
        "imageName":{
            "description":"name of the image",
            "type":"string",
            "example":"Tier1 SI 19.14"
        },
        "isImageUptodate":{
            "description":"Flag to indicate if the image is uptodate",
            "type":"boolean"
        },
        "imageVersionName":{
            "description":"name of the image version",
            "type":"string",
            "example":"Version-1"
        },
        "imageVersionDescription":{
            "description":"description of the image version",
            "type":"string",
            "example":""
        },
        "isCurrentImage":{
            "description":"Flag indicates if the image is current version",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag indicates if there is a uptodate image version",
            "type":"boolean"
        },
        "patchCompliance":{
            "description":"Patch compliance of Target, can be either 'DRIFTED'-if the target has additional patches than in image and are not recommended patches or <Version Name> - on which the target is patched",
            "type":"string",
            "example":"DRIFTED"
        },
        "currentVersionName":{
            "description":"Name of the 'CURRENT' image version",
            "type":"string",
            "example":"19DBRU15"
        },
        "additionalPatchCount":{
            "description":"Count of additional patches in target not present in image and are not not recommended patches",
            "type":"integer",
            "example":2
        }
    }
}

Nested Schema : TargetPatchComplianceDetails

Type: object

Target details

Show Source

• dbMachineName: string
  DB Machine name

  Example: myDbMachine.oracle.com

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

Match All

Target details

Show Source

• object TargetDetails
  details of target

{
    "description":"Target details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetDetails"
        }
    ],
    "properties":{
        "dbMachineName":{
            "description":"DB Machine name",
            "type":"string",
            "example":"myDbMachine.oracle.com"
        }
    }
}

Nested Schema : TargetDetails

Type: object

details of target

Show Source

• clusterName: string
  name of the cluster

  Example: phxem0405c
• dataguardRole: string
  Enum for Data Guard role
• displayName: string
  display name of the target

  Example: sdb2ra00
• hostname: string
  name of the host

  Example: myHostName.mycompany.com
• isCdb: string
  Flag to indicate if the DB is CDB

  Example: true
• platform: string
  Platform of the target

  Example: Linux_AMD64
• release: string
  database release

  Example: 19.14.0.0.0
• targetId: string
  Id of the target

  Example: 09216A9333889316155C3B7DFF9820C7
• targetName: string
  name of the target

  Example: sdb2ra00
• targetStatus: number
  status of the target

  Example: 1
• targetType: string
  Allowed Values: [ "rac_database", "oracle_database", "cluster", "has" ]

  type of the target

{
    "description":"details of target",
    "type":"object",
    "properties":{
        "targetId":{
            "description":"Id of the target",
            "type":"string",
            "example":"09216A9333889316155C3B7DFF9820C7"
        },
        "targetName":{
            "description":"name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "targetType":{
            "description":"type of the target",
            "type":"string",
            "enum":[
                "rac_database",
                "oracle_database",
                "cluster",
                "has"
            ]
        },
        "targetStatus":{
            "description":"status of the target",
            "type":"number",
            "example":1
        },
        "displayName":{
            "description":"display name of the target",
            "type":"string",
            "example":"sdb2ra00"
        },
        "dataguardRole":{
            "$ref":"#/components/schemas/DataguardRoleEnum"
        },
        "isCdb":{
            "description":"Flag to indicate if the DB is CDB",
            "type":"string",
            "example":"true"
        },
        "hostname":{
            "description":"name of the host",
            "type":"string",
            "example":"myHostName.mycompany.com"
        },
        "clusterName":{
            "description":"name of the cluster",
            "type":"string",
            "example":"phxem0405c"
        },
        "release":{
            "description":"database release",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "platform":{
            "description":"Platform of the target",
            "type":"string",
            "example":"Linux_AMD64"
        }
    }
}

Examples

Select an example Filter on Target properties

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top