Case Integration Guide

Please read the General integration guide to learn the general concepts and common data structures used throughout the Argus API.

Tip

The Swagger API documentation is always up-to-date and lets you try out any query with your user session or an API-key.

contents

• Case General Integration Guide
  • Fetching a case
  • Creating a case
    • Creating a restricted case
    • Uploading attachments before creating a case
  • Updating a case
    • Related endpoints
    • Restricted fields
    • Update with comment
  • Closing a case
  • Case status
  • Description and comment markup
  • Searching for cases
    • Simple search
    • Advanced search
      • Subcriteria
      • Exclude subcriteria
      • Searching for cases by user
      • Searching for cases by time
      • Searching for cases by keywords
  • Managing comments
    • Listing comments
    • Comment flags
    • Comment references
    • Fetching a specific comment
    • Adding a comment
  • Fetching events
  • Managing attachments
    • Listing attachments
    • Downloading an attachment
    • Adding an attachment
  • Case watchers
    • Adding an explicit user watcher
    • Verbose watchers
    • Watchers and access control
  • Managing case tags
    • Listing tags
    • Adding a tag
    • Removing a tag
  • Moving a case
  • Fetching services
  • Fetching service subscription
  • Fetching categories
• Case Fields Integration Guide
  • Introduction
  • Concepts
  • Case Field Descriptor
  • Field types
    • Creating a new field
  • Using case fields
    • Setting a field value
    • Listing fields
    • Fetching a field value
    • Field value info objects
    • Setting multivalue fields
  • Advanced field options
    • Using Field Access Control
    • Using Field Validators
    • Using Field Value Sources
    • Querying the value source
  • Field Policies
    • Listing available policies
• Understanding Case Access Control
  • Access modes
  • Access levels
  • Access roles
  • Determining access level and role
  • Changing case access mode
  • Granting case access
  • List case access
  • Revoking case access
• Case Websockets
  • Getting started
  • Usage and client requirements
    • Connection shutdown
  • Websocket data format
  • Available websocket endpoints
    • Case Update Websocket
      • Endpoint
      • Parameters
      • Message types
    • Case Activity Websocket
      • Endpoint
    • Parameters
      • Message types
• Case History
  • Case Transaction
    • Operations
  • Change event
    • Fields
    • Object types