Skip to content
Overview/
/Events and Alarms/
Changed
Last updated

Events and Alarms

POST /alarms/metas/query

Get Alarms Meta Data

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Return Type:
  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property mspEcAlarmCountList (object)

      MSP EC Alarm Count.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property status (object)

      The current status of the alarm data request.

    • Changed property totalCount (object)

      The total number of alarms matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property mspEcAlarmCountList (object)

      MSP EC Alarm Count.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property status (object)

      The current status of the alarm data request.

    • Changed property totalCount (object)

      The total number of alarms matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

POST /alarms/query
Request:
  • Changed content type : application/json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters for the query.

  • Changed property mspEcTenants (object)

    MSP EC tenants filter for the query.

  • Changed property page (object)

    Page number for pagination.

  • Changed property pageSize (object)

    Page size for pagination.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc
  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters for the query.

  • Changed property mspEcTenants (object)

    MSP EC tenants filter for the query.

  • Changed property page (object)

    Page number for pagination.

  • Changed property pageSize (object)

    Page size for pagination.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc
Return Type:
  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property mspEcAlarmCountList (object)

      MSP EC Alarm Count.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property status (object)

      The current status of the alarm data request.

    • Changed property totalCount (object)

      The total number of alarms matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property mspEcAlarmCountList (object)

      MSP EC Alarm Count.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property status (object)

      The current status of the alarm data request.

    • Changed property totalCount (object)

      The total number of alarms matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

PATCH /alarms/{alarmId}
Return Type:
  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

GET /events/adminGroups/{adminGroupId}/latestLogins
Return Type:
  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

POST /events/csvFiles

Export Events Within Date Range

Request:
  • Changed content type : application/json

  • Added property groupBy (object)

    Group by field.

  • Added property matchFields (object)

    Match fields for the query.

  • Added property mustNotMatchFields (object)

    Must not match fields for the query.

  • Added property page (object)

    Page number for pagination.

  • Added property pageSize (object)

    Number of records per page.

  • Added property rangeFilter (object)

    Definition for range based filtering criteria.

    • Property field (object)

      Field on which range filter is applied.

    • Property gte (object)

      Greater than or equal to value.

    • Property lte (object)

      Less than or equal to value.

  • Changed property clientDateFormat (object)

    Client date format.

  • Changed property clientTimeZone (object)

    Client time zone.

  • Changed property detailLevel (object)

    Detail level of the event data.

  • Changed property eventsPeriodForExport (object)

    Events period for export.

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters for the query.

  • Changed property isSupport (object)

    Is support user or not.

  • Changed property searchString (object)

    Search string provided by user.

  • Changed property searchTargetFields (object)

    Fields to be searched.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc

  • Changed property support (object)

    Is support user or not.

  • Changed property tenantId (object)

    The unique identifier for the tenant.

  • Changed property termField (object)

    Definition for exact term matching criteria.

    • Changed property field (object)

      The name of the field to match against.

  • Changed content type : application/vnd.ruckus.v1+json

  • Added property groupBy (object)

    Group by field.

  • Added property matchFields (object)

    Match fields for the query.

  • Added property mustNotMatchFields (object)

    Must not match fields for the query.

  • Added property page (object)

    Page number for pagination.

  • Added property pageSize (object)

    Number of records per page.

  • Added property rangeFilter (object)

    Definition for range based filtering criteria.

  • Changed property clientDateFormat (object)

    Client date format.

  • Changed property clientTimeZone (object)

    Client time zone.

  • Changed property detailLevel (object)

    Detail level of the event data.

  • Changed property eventsPeriodForExport (object)

    Events period for export.

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters for the query.

  • Changed property isSupport (object)

    Is support user or not.

  • Changed property searchString (object)

    Search string provided by user.

  • Changed property searchTargetFields (object)

    Fields to be searched.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc

  • Changed property support (object)

    Is support user or not.

  • Changed property tenantId (object)

    The unique identifier for the tenant.

  • Changed property termField (object)

    Definition for exact term matching criteria.

    • Changed property field (object)

      The name of the field to match against.

Return Type:
  • Changed response : 200 OK

successful operation

  • Deleted content type : application/vnd.ruckus.v1+json

  • Changed content type : application/json

  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

POST /events/details/query

Get Events Details Data

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Return Type:
  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

POST /events/metas/query

Get Events Meta Data

Request:
  • Changed content type : application/json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

Return Type:
  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

POST /events/query
Request:
  • Changed content type : application/json

  • Changed property detailLevel (object)

    Detail level of the event data.

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Users need to pass a list of string or string as map values.

  • Changed property page (object)

    Page number for pagination.

  • Changed property pageSize (object)

    Number of records per page.

  • Changed property searchString (object)

    Search string provided by user.

  • Changed property searchTargetFields (object)

    Fields to be searched.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc
  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property detailLevel (object)

    Detail level of the event data.

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Users need to pass a list of string or string as map values.

  • Changed property page (object)

    Page number for pagination.

  • Changed property pageSize (object)

    Number of records per page.

  • Changed property searchString (object)

    Search string provided by user.

  • Changed property searchTargetFields (object)

    Fields to be searched.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc
Return Type:
  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

POST /historicalClients/query
Request:
  • Changed content type : application/json

  • Changed property detailLevel (object)

    Detail level of the event data.

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Users need to pass a list of string or string as map values.

  • Changed property page (object)

    Page number for pagination.

  • Changed property pageSize (object)

    Number of records per page.

  • Changed property searchString (object)

    Search string provided by user.

  • Changed property searchTargetFields (object)

    Fields to be searched.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc
  • Changed content type : application/vnd.ruckus.v1+json

  • Changed property detailLevel (object)

    Detail level of the event data.

  • Changed property fields (object)

    Fields to be returned in response.

  • Changed property filters (object)

    Users need to pass a list of string or string as map values.

  • Changed property page (object)

    Page number for pagination.

  • Changed property pageSize (object)

    Number of records per page.

  • Changed property searchString (object)

    Search string provided by user.

  • Changed property searchTargetFields (object)

    Fields to be searched.

  • Changed property sortField (object)

    Field to sort the results on.

  • Changed property sortOrder (object)

    The order in which results should be sorted.

    Added enum values:

    • asc
    • desc
Return Type:
  • Changed response : 200 OK

successful operation

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed content type : application/vnd.ruckus.v1+json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property fields (object)

      Relevant fields.

    • Changed property message (object)

      A human-readable message describing any error that occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property totalCount (object)

      The total number of events matching the query.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 400 Bad Request

Invalid payload supplied

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

  • Changed response : 500 Internal Server Error

Internal Server Error

  • Changed content type : application/json

    • Changed property errors (object)

      A collection of error objects if multiple errors occurred.

    • Changed property requestId (object)

      Request ID associated with the error.

    • Changed property error (object)

      Model representing error information.

      • Changed property code (object)

        The error code identifying the type of error.

      • Changed property message (object)

        A human-readable message describing the error.

      • Changed property reason (object)

        Reason for the error.

      • Changed property suggestion (object)

        Suggestion to resolve the error.

Previous page
Next page