latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

event_schemas

Update an event schema

put/app/v1/event_schemas/{id}

Path parameters

idstring uuid required

Event Schema ID

Request body

namestring
versionstring
priority'high' | 'medium' | 'low'
status'active' | 'archived'
descriptionstring
event_category_idstring uuid

Example request

{
  "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
    }
  }
}

Response

A successful operation

namestring
versionstring
priority'high' | 'medium' | 'low'
status'active' | 'archived'
descriptionstring
event_category_idstring uuid
idstring uuid
company_idstring uuid
created_atstring date-time
created_bystring uuid
updated_atstring date-time
updated_bystring uuid

Example response

{
  "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
    }
  }
}