{
"swagger": "2.0",
"info": {
"description": "The Event Handler API (beta) was introduced in XNAT 1.7 to handle events thrown by the Automation Service.",
"version": "1.7.4.1",
"title": "Event Handler API"
},
"tags": [
{
"name": "event-handler-api",
"description": "Event Handler API"
}
],
"definitions": {
"EventClassInfo": {
"type": "object",
"properties": {
"class": {
"type": "string",
"description": "Event class name (Should implement AutomationEventImplementerI"
},
"description": {
"type": "string",
"description": "Description"
},
"displayName": {
"type": "string",
"description": "Display Name"
},
"eventIds": {
"type": "array",
"description": "List of event IDs.",
"items": {"type": "string"}
},
"filterableFields": {
"type": "object",
"description": "Map of Filterable fields.",
"additionalProperties": {"$ref": "#/definitions/EventHandlerFilterInfo"}
},
"includeEventIdsFromDatabase": {"type": "boolean"}
},
"description": "Event class names and filterable fields."
},
"EventHandlerFilterInfo": {
"type": "object",
"properties": {
"defaultValue": {
"type": "string",
"description": "Default selected value for event filter values"
},
"filterRequired": {
"type": "boolean",
"description": "Filter Required?"
},
"filterValues": {
"type": "array",
"description": "Filter Values",
"items": {"type": "string"}
},
"includeValuesFromDatabase": {
"type": "boolean",
"description": "Include Values From Database?"
}
},
"description": "Event class names and filterable fields."
}
},
"paths": {
"/xapi/eventHandlers/automationEventClasses": {"get": {
"tags": ["event-handler-api"],
"summary": "Get list of event classes.",
"description": "Returns a list of classes implementing AutomationEventI.",
"operationId": "automationEventClassesGetUsingGET",
"consumes": ["application/json"],
"produces": ["application/json"],
"responses": {
"200": {
"description": "An array of class names",
"schema": {
"type": "array",
"items": {"$ref": "#/definitions/EventClassInfo"}
}
},
"401": {"description": "Unauthorized"},
"500": {"description": "Unexpected error"},
"403": {"description": "Forbidden"},
"404": {"description": "Not Found"}
}
}},
"/xapi/projects/{projectId}/eventHandlers/automationEventClasses": {"get": {
"tags": ["event-handler-api"],
"summary": "Get list of event classes.",
"description": "Returns a list of classes implementing AutomationEventI.",
"operationId": "automationEventClassesGetByProjectUsingGET",
"consumes": ["application/json"],
"produces": ["application/json"],
"parameters": [{
"name": "projectId",
"in": "path",
"description": "projectId",
"required": true,
"type": "string"
}],
"responses": {
"200": {
"description": "An array of class names",
"schema": {
"type": "array",
"items": {"$ref": "#/definitions/EventClassInfo"}
}
},
"401": {"description": "Unauthorized"},
"500": {"description": "Unexpected error"},
"403": {"description": "Forbidden"},
"404": {"description": "Not Found"}
}
}},
}
}
Overview
Community Forums
Content Tools
Apps