What are mutations?
createSession, deleteSession, getToken, restoreSession
Mutations allow you to create, update, and delete data. The majority of our mutations have the following prefixes:
- Save - Create or Update. We usually determine if you would like to create or update data depending on if you provide a valid
id
argument. - Delete - Delete. This will usually return a Deleted object type, but, some mutations will return an updated version of the sibling data if this is more useful.
- Toggle - Toggle a boolean state, such as following or unfollowing a user. Like a query, mutations allow you to specify which fields you would like to be returned from the updated object.
createSession
Type: Session
Creates Session with specified params. Used for wrapping up one or more checks. It will go through all configured checks and retrieve results for each of the Checks.
Arguments
Name | Description |
---|---|
itemSessionInput! | Input data for creating a new session. |
deleteSession
Type: Session
Stop session from running.
Arguments
Name | Description |
---|---|
idID! | A unique identifier of a session that will be deleted. |
getToken
Type: String
Generates authentication token for API based on token provided for company. Expiration time is 30 min.
restoreSession
Type: Session
Restore deleted Session.
Arguments
Name | Description |
---|---|
idID! | A unique identifier of a session that will be restored. |