SAYMON SAYMON REST API

SAYMON REST API

    • REST API
      • Postman Collection
      • General
        • Permissions
        • Response errors
      • Methods
        • Agents
          • Update Agent
          • Update All Agents
        • Authentication
          • Authentication
          • Authentication Token
            • Create Authentication Token
            • Delete Authentication Token
          • Session ID
            • Create Session ID
            • Delete Session ID
            • Verify Session ID
        • Bulks
          • Get Bulk Operation Status
          • Run Bulk Operation for Objects
        • Classes
          • State Conditions
            • Get Class’s State Conditions
            • Set Class’s State Conditions
            • Check If Class’s State Conditions Exist
          • Incident Conditions
            • Get Class’s Incident Conditions
            • Set Class’s Incident Conditions
          • Create Class
          • Get Class by ID
          • Get All Classes
          • Update Class
          • Delete Class by ID
          • Count Class’s Objects
        • Security
          • Get Security Log
        • Server Configuration
          • Password Policy
            • Create Password Policy
            • Get All Password Policies
            • Update Password Policy
            • Delete Password Policy
          • Password Log
            • Get Password Log
            • Get Password Expiration Time
          • Get All Custom Triggers
          • Get Server Configuration
          • Get All Custom Tasks
          • Update Server Configuration
        • Client Configuration
          • Get Client Configuration
          • Update Client Configuration
          • Reset Client Configuration
        • Dictionaries
          • Create Dictionary
          • Get All Dictionaries
          • Update Dictionary
          • Delete Dictionary by ID
        • Entities
          • Stat
            • Get Entity Stat
            • Set Entity Stat
          • State
            • Set Entity State
            • Set Entity’s Manual State
          • Get Entity by ID
          • Get Entity Children
          • Get All Root Entities
        • Event Log
          • Storage
            • Update Storage Limits For Event Log
            • Get Event Log Storage Info
          • Assign Event Log Record to User
          • Get Event Log
          • Get Event Log Modifications
          • Update Event Log Record Payload
          • Delete Event Log Record
        • Extensions
          • Get All Backend Extensions
        • Flows
          • Documents
            • Get Flow’s Document
            • Add Document to Flow
            • Delete Flow’s Document
          • Create Flow
          • Get All Flows
          • Update Flow
          • Delete Flow
        • History Annotations
          • Create History Annotation
          • Get History Annotations
          • Update History Annotation
          • Delete History Annotation
        • Incident Levels
          • Create Incident Level
          • Get All Incident Levels
          • Update Incident Level
          • Delete Incident Level
        • Incidents
          • Get Incident by ID
          • Get All Incidents
          • Clear Incident
          • Clear and Remove Incident
          • Remove Incident from the History
          • Undo Clear Incident
          • Undo Remove Incident
          • Acknowledge Incident
          • Undo Incident Acknowledgement
          • Get Number Of Active Incidents
          • Add Incident Comment
          • Get Incident Comment History
          • Get Incidents History
          • Get Comments List for Historic Incident
        • Jobs
          • Get Link’s Job History
          • Get Object’s Job History
          • Get Job by Object/Link IDs
          • Get Job by ID
          • Add Custom Job Result
        • Limits
          • Get list of blocked requests
        • Links
          • State Conditions
            • Get Link’s State Conditions
            • Set Link’s State Conditions
            • Delete Link’s State Conditions
            • Check If Link’s State Conditions Exist
          • Config Log
            • Get Link’s Config Log
            • Get Link’s Config Log Item
          • State
            • Get Link’s State Triggers
            • Set Link’s State Triggers
            • Set Link’s Manual State
            • Get Link’s State History
            • Set Link’s State
          • Stat
            • Get Link’s Stat
            • Set Link’s Stat
            • Get Link’s Stat Metadata
            • Set Link’s Stat Metadata
            • Get Link’s Stat Metrics
            • Get Link’s Metrics History
            • Get Link’s N Last Metrics
          • Incident Conditions
            • Set Link’s Incident Conditions
            • Get Link’s Incident Conditions
            • Delete Link’s Incident Conditions
          • Documents
            • Add Document to Link
            • Get Link’s Document
            • Delete Link’s Document
          • Create Link
          • Get Link by ID
          • Get All Links
          • Get Link’s Parent Paths
          • Get Link’s Audit Log
          • Update Link
          • Delete Link by ID
        • Metric Tokens
          • Create Metric Token
          • Get Entity Stat with Metric Token
          • Get Entity History Data
        • MQTT
          • Get All MQTT Subscriptions
        • Notification Templates
          • Get All Notification Templates
          • Get Notification Template Preview
          • Update Notification Template
          • Restore Default Notification Template
        • Objects
          • State Conditions
            • Set Object’s State Conditions
            • Get Object’s State Conditions
            • Delete Object’s State Conditions
            • Check If Object’s State Conditions Exist
          • Config Log
            • Get Object’s Config Log
            • Get Object’s Config Log Item
          • State
            • Set Object’s State
            • Set Object’s Manual State
            • Get Object’s State History
            • Get Object’s State Triggers
            • Set Object’s State Triggers
          • Stat
            • Get Object’s Stat
            • Set Object’s Stat
            • Get Object’s Stat Metrics
            • Get Object’s Metrics History
            • Get Object’s N Last Metrics
            • Get Object’s Stat Metadata
            • Set Object’s Stat Metadata
          • Incident Conditions
            • Get Object’s Incident Conditions
            • Set Object’s Incident Conditions
            • Delete Object’s Incident Conditions
          • Documents
            • Add Document to Object
            • Get Object’s Document
            • Delete Object’s Document
          • Create Object
          • Get Object by ID
          • Get All Objects
          • Update Object
          • Delete Object by ID
          • Get Object’s Parent Paths
          • Get Object’s Audit Log
          • Get Object’s Children
          • Get Object’s Children Links
          • Clone Object
          • Clone Object in Background
          • Get Objects' Properties Names
          • Search Objects
        • Operations
          • Entity Operations
            • Execute Entity Operation
          • Link Operations
            • Create Link Operation
            • Update Link Operation
            • Delete Link Operation
            • Execute Link Operation
          • Class Operations
            • Create Class Operation
            • Update Class Operation
            • Delete Class Operation
          • Object Operations
            • Create Object Operation
            • Update Object Operation
            • Execute Object Operation
            • Delete Object Operation
          • Get Operation ID
        • Presets
          • Create Preset
          • Get All Presets
          • Update Preset
        • Properties
          • Entity Properties
            • Get Entity Properties
          • Object Properties
            • Create Object Property
            • Get Object Properties
            • Update Object Property
            • Delete Object Property
          • Class Properties
            • Create Class Property
            • Get Class Properties
            • Update Class Property
            • Delete Class Property
          • Flow Properties
            • Create Flow Property
            • Get Flow Properties
            • Update Flow Property
            • Delete Flow Property
          • Link Properties
            • Create Link Property
            • Get Link Properties
            • Update Link Property
            • Delete Link Property
          • Incident Properties
            • Set Incident Properties
            • Delete Incident Properties
        • References
          • Create Reference
          • Get All References
          • Get Reference by ID
          • Update Reference
          • Delete Reference by ID
        • Reports
          • Generate Excel Chart Report
          • Generate Excel Report of Incident History
          • Generate CSV Report of Incidents History
          • Generate Excel Report of Active Incidents
          • Generate Property Inventory Report
        • Scripts
          • Create Script
          • Get All Scripts
          • Update Script
          • Delete Script by ID
          • Get Script’s Usage Count
        • Service
          • Ping Server
          • Get SAYMON Version
          • Get SAYMON Version Hash
          • Get Server Time
          • Run Consistency Check
        • Stat
          • Get Stat History
          • Get Stat for Several Entities
        • Stat Rules
          • Objects
            • Get Object Stat Rules
            • Set Object Stat Rules
          • Links
            • Get Link Stat Rules
            • Set Link Stat Rules
        • State History
          • Get State History Log
          • Get All State History
          • Update State Comment
        • States
          • Create State
          • Get All States
          • Delete State
        • Tags
          • Create Tag
          • Get All Tags
        • User Groups
          • Create User Group
          • Get All User Groups
          • Update User Group
          • Delete User Group
        • Users
          • Favorites
            • Get Favorites
            • Set Favorites
          • Register User
            • Confirm Registration
            • Register User
            • Generate CAPTCHA
          • Passwords
            • Change User’s Password
            • Restore User’s Password
            • Send Restore Password Email
          • Log
            • Get Users' Sessions Log
            • Get User’s Audit Log
          • Create User
          • Get Current User
          • Get User by ID
          • Get All Users
          • Update User
          • Delete User
          • Search Users
      • Misc
        • Sections' names
        • Conditions
        • EntityTypes
        • Incident Filters
        • State Change Reason
        • Security Event Classes
      • Models
        • Audit Log
        • Backend Extensions
        • Class
        • Server Configuration
        • Client Configuration
        • Dictionary
        • Event Filter
        • Event Log
        • Flow
        • Favorites
        • History Annotation
        • Incident Condition
        • Incident Level
        • Incident
        • Incident Comment
        • Job
        • Link
        • Manual State
        • Notification Template
        • Object
        • Operation
        • Password Policy
        • Password Log
        • Preset
        • Property
        • Reference
        • Script
        • Security Log
        • Stat
        • Stat Metadata
        • Stat Rule
        • State
        • State Change Condition
        • State Trigger
        • State History
        • Tag
        • User
        • User Group
        • Widget
    • Socket.IO
      • Entity State
        • State Change Event
      • Client Event
        • Client Notification Event
      • Entity Stat
        • Stat Event
      • Server Events
        • Bulk Operation Finished Event
        • Custom Server Event
        • Job Added Event
        • Job Result Received Event
        • MQTT Event
        • SNMP Trap Event
      • Model Events
        • Model Changed Event
      • Incidents
        • Incidents Event
        • Incident Count Event
      • Error Event
      • Custom Style Change Event
    • Cookbook
      • Metrics
        • How to get minimum, maximum, and average values of metrics
      • Download Document
      • Upload background image to an object
    • Release Notes
  • SAYMON REST API
  • Cookbook

Cookbook

This section is a work in progress and will be expanded in the future.

This section contains examples that demonstrate how to solve common problems while using SAYMON REST API.

  • Metrics

    • How to get minimum, maximum, and average values of metrics

  • Files on the server

    • Download Document

    • Upload background image to an object

Custom Style Change Event How to get minimum, maximum, and average values of metrics