Jump to

• Request
• Response

Get Global Setting for Certificate Warning

get

/api/core/CertificateWarning

Gets the global properties related to certificate warnings, primarily to make the user aware of the possible expiry of the certificate. If the property value is returned as 1, certificate warning is displayed on the user interface.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/coreGlobalPropertiesCertificateWarning"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/coreGlobalPropertiesCertificateWarning"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object coreGlobalPropertiesCertificateWarning

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/coreGlobalPropertiesCertificateWarning"
    }
}

Nested Schema : coreGlobalPropertiesCertificateWarning

Type: object

Show Source

• Description: string
  The description.

  Example: Example Description
• PropertyName: string
  The property name.

  Example: CertificateAuthorityWarning
• PropertyValue: integer
  The property value.

  Example: 1

{
    "properties":{
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"CertificateAuthorityWarning"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"integer",
            "example":"1"
        },
        "Description":{
            "description":"The description.",
            "type":"string",
            "example":"Example Description"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top