GraphQL queries

Read operations available on the public schema.

ℹ

The blocks labelled Schema below are SDL — they describe types and inputs, and are not valid to send to the GraphQL endpoint. Send only the blocks labelled Query. If you copy-paste a schema block into the playground you'll get The "X" definition is not executable.

apiVersion

Echoes the API version that the request is being processed under, plus the list of supported versions.

Schema

type PublicApiVersion {
  current: String!
  supported: [String!]!
  header: String!
}

Query

query CurrentApiVersion {
  apiVersion {
    current
    supported
  }
}

me

The user account that owns the API key.

Schema

type PublicUser {
  id: ID!
  email: String
  firstname: String
  lastname: String
  recentTeam: String
}

Query

query Me {
  me {
    id
    email
    firstname
    lastname
  }
}

processes / processesPulled

processesPulled has the exact same signature as processes; it's shorthand for processes(input: { pulled: true }).

Schema

input PublicListInput {
  search: String
  limit: Int
  offset: Int
  pulled: Boolean
}

type PublicProcessesPage {
  items: [PublicProcess!]!
  total: Int
  hasMore: Boolean
}

type PublicProcess {
  id: ID!
  name: String
  description: String
  source: String
  sourceOrganization: String
  functionalUnit: String
  region: String
  datePublished: String
  revealed: Boolean
}

Query — with variables

query SearchProcesses($input: PublicListInput) {
  processes(input: $input) {
    items { id name region }
    total
    hasMore
  }
}

Variables panel:

{ "input": { "search": "injection", "limit": 10 } }

Query — inline literal

query MyPulledProcesses {
  processesPulled(input: { limit: 20 }) {
    items { id name region }
    hasMore
  }
}

materials / materialsPulled

materialsPulled mirrors materials with pulled implicitly true.

Schema

type PublicMaterialsPage {
  items: [PublicMaterial!]!
  total: Int!
}

type PublicMaterial {
  id: ID!
  name: String
  description: String
  source: String
  sourceOrganization: String
  functionalUnit: String
  compartment: String
  datePublished: String
  revealed: Boolean
}

Query — with variables

query SearchMaterials($input: PublicListInput) {
  materials(input: $input) {
    items { id name datePublished }
    total
  }
}

Variables panel:

{ "input": { "pulled": true, "limit": 20 } }

Query — inline literal

query MyPulledMaterials {
  materialsPulled(input: { limit: 20 }) {
    items { id name datePublished }
    total
  }
}