Contents x
    Get errors and alerts of a log
    • 25 Nov 2023
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Get errors and alerts of a log

    • Updated on 25 Nov 2023
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    Get
    /v2/APIReferences/{apiReferenceId}/Logs/{logId}
    Security
    API Key
    Header parameter nameapi_token
    Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
    Path parameters
    apiReferenceId
    stringRequired

    The ID of the API reference

    logId
    stringRequired

    The ID of the log

    Responses
    200

    Success

    Success status Response

    This is the sample response for single API reference log.

    {
  "api_reference_errors": [
    {
      "message": "Declared path parameter \"contentId\" needs to be defined as a path parameter at either the path or operation level",
      "pointer": "#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"
    }
  ],
  "api_reference_alerts": [
    {
      "message": "Data and type mismatch found.",
      "pointer": "#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    api_reference_errors
    Array of object (ApiLogs)

    Error log response

    object
    message
    string

    Descriptive message represent the problem occur

    pointer
    string

    Path where the problem occur

    api_reference_alerts
    Array of object (ApiLogs)

    Alerts log response

    object
    message
    string

    Descriptive message represent the problem occur

    pointer
    string

    Path where the problem occur

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api response

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    400

    Bad Request

    Invalid API reference ID

    Kindly ensure that the given API reference ID is valid.

    {
  "api_reference_errors": [],
  "api_reference_alerts": [],
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Api reference not found.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Invalid API reference log ID

    Kindly ensure that the given log Id is in the API reference.

    {
  "api_reference_errors": [],
  "api_reference_alerts": [],
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Logs not found.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Expand All
    object
    api_reference_errors
    Array of object (ApiLogs)

    Error log response

    object
    message
    string

    Descriptive message represent the problem occur

    pointer
    string

    Path where the problem occur

    api_reference_alerts
    Array of object (ApiLogs)

    Alerts log response

    object
    message
    string

    Descriptive message represent the problem occur

    pointer
    string

    Path where the problem occur

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api response

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    Was this article helpful?
    What's Next