ALERTS_V1

Create

Changed on

Create a new alert or report rule.

post/api/v1/alerts/rules

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/api/v1/alerts/rules
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

namestring nullable
descriptionstring nullable
rule_typestring nullable
sourcestring nullable
platformstring nullable
entity_typestring nullable
session_idstring nullable
content_scopestring nullable
alert_messagestring nullable
visibilitystring nullable

Response

Successful Response

idinteger required
namestring required
descriptionstring nullable
rule_typestring required
sourcestring
platformstring nullable
categorystring nullable
entity_typestring nullable
session_idstring nullable
content_scopestring nullable
deliveryobject nullable
alert_messagestring nullable
statusstring required
created_atstring date-time required
updated_atstring date-time required
created_byinteger required
visibilitystring
team_idinteger nullable
can_editboolean
can_deleteboolean
can_shareboolean
summarystring nullable

Changes

  • 70e0a3e5cb0dRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 6aa0788aa5dcRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      response property entity_type list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      response property platform list-of-types was widened by adding types null to media type application/json of response 201

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #2 to the response property anyOf list for the response status

    • info

      added the required property // to the response with the status