Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

event_schemas

Search and list event schemas

post/app/v1/event_schemas/search

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'name' | 'description' | 'status' | 'version' | 'priority' | 'event_category.id' | 'event_category.name'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "version": "V1",
    "status": "active",
    "name": {
      "$like": "leak"
    }
  }
}

Response

A successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "config": {
        "has_due_date": true,
        "due_date": {
          "relative_time": true,
          "time_period": "days",
          "duration": 7
        },
        "forms": {
          "required_templates": [
            "c482584f-0402-4b6f-9ca4-124e2775a172"
          ],
          "suggested_templates": [
            "43c0aab0-2a67-47c1-aa7d-cb16055d6432"
          ]
        },
        "equipment": {
          "is_mandatory": true,
          "has_source": true
        }
      }
    }
  ]
}