router-schema.md

Schema Types

Table of Contents

• Query
• Mutation
• Objects
  • Action
  • ActionResponse
  • DeleteResponse
  • Route
  • RouteResponse
• Inputs
  • ActionCreateRequest
  • ActionUpdateRequest
  • RouteCreateRequest
  • RouteUpdateRequest
• Enums
  • ActionType
• Scalars
  • Boolean
  • ID
  • Int
  • JSON
  • String

Query

Field	Argument	Type	Description
Action		[Action]
id		ID
name		String
alarmId		ID
routeId		ID
limit		Int
offset		Int
sortBy		String
Route		[Route]
id		ID
name		String
type		String
actionId		ID
alarmId		ID
limit		Int
offset		Int
sortBy		String

Mutation

Field	Argument	Type	Description
ActionCreate		ActionResponse
input		ActionCreateRequest!
ActionUpdate		ActionResponse
id		ID!
input		ActionUpdateRequest!
ActionDelete		DeleteResponse
id		ID!
RouteCreate		RouteResponse
input		RouteCreateRequest!
RouteUpdate		RouteResponse
id		ID!
input		RouteUpdateRequest!
RouteDelete		DeleteResponse
id		ID!
RouteAssociate		RouteResponse
actionId		ID!
routeId		ID!
RouteDissociate		RouteResponse
actionId		ID!
routeId		ID!

Objects

Action

Field	Argument	Type	Description
id		ID!
name		String!
description		String
alarmIds		[ID]
routes		[Route]
tsCreated		String!
tsModified		String!

ActionResponse

Field	Argument	Type	Description
error		String
action		Action

DeleteResponse

Field	Argument	Type	Description
error		String

Route

Field	Argument	Type	Description
id		ID!
name		String!
description		String
type		ActionType!
config		JSON
tsCreated		String!
tsModified		String!

RouteResponse

Field	Argument	Type	Description
error		String
route		Route

Inputs

ActionCreateRequest

Field		Type	Description
name		String!
description		String
alarmIds		[ID!]

ActionUpdateRequest

Field		Type	Description
name		String
description		String
alarmIds		[ID!]

RouteCreateRequest

Field		Type	Description
name		String!
description		String
type		ActionType!
config		JSON

RouteUpdateRequest

Field		Type	Description
name		String
description		String
type		ActionType
config		JSON

Enums

ActionType

Value	Description
EMAIL
SMS
ENDPOINT

Scalars

Boolean

The Boolean scalar type represents true or false.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSON

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.