Graph search · GraphQL mutation

graphSearchJobCancel mutation

Cancels a running graph search job started by graphSearch, setting its state to USER_CANCEL. A job that is no longer running is returned unchanged. Allowed for the user who started the job and for organization administrators.

Response

Returns a GraphSearchJobCancelPayload!

Arguments

Name Description
input - GraphSearchJobCancelInput! The search job identifier.

Example

Query

mutation graphSearchJobCancel($input: GraphSearchJobCancelInput!) {
  graphSearchJobCancel(input: $input) {
    searchJob {
      id
      orgId
      requestedInput {
        ...GraphSearchInputPayloadFragment
      }
      effectiveInput {
        ...GraphSearchInputPayloadFragment
      }
      hash
      user {
        ...UserFragment
      }
      state
      errors
      resultsCount
      hasResults
      startedAt
      endedAt
      running
      duration
      updatedAt
      accessedAt
      winningTrace {
        ...SearchTraceStageFragment
      }
      unselectedTraces {
        ...SearchTraceStageFragment
      }
    }
  }
}

Variables

{"input": GraphSearchJobCancelInput}

Response

{
  "data": {
    "graphSearchJobCancel": {"searchJob": GraphSearchJob}
  }
}