Skip to main content
POST
/
graphql#ListMappings
List mappings
curl --request POST \
  --url 'https://clarus-api.com/graphql#ListMappings' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "query": "query($filter: MappingFilterType) { mappings { all(filter: $filter) { edges { node { id mapping_group_id mapping_fields { id code value } } } } } }"
}
'
{
  "data": {
    "mappings": {
      "all": {
        "edges": [
          {
            "node": {
              "id": "1204",
              "mapping_group_id": "88",
              "mapping_fields": [
                {
                  "id": "9001",
                  "code": "reason_code",
                  "value": "DAMAGED"
                },
                {
                  "id": "9002",
                  "code": "reason_code_to",
                  "value": "QC_HOLD"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

​
Query Structure

query($filter: MappingFilterType) {
  mappings {
    all(filter: $filter) {
      edges {
        node {
          id
          mapping_group_id
          mapping_fields { id code value }
        }
      }
    }
  }
}

​
Filter Argument

All filters are passed inside the filter argument. Each filter field accepts an input object with operators (e.g. eq, ilike, from, to, between): 
{
  "filter": {
    "id": {
      "eq": "value"
    }
  }
}

​
Available Filters

FilterInput TypeOperatorsDescription
idIdInputTypeeq, in, gt, gteq, lt, lteq, filledMapping ID
mapping_group_idIdInputTypeeq, in, gt, gteq, lt, lteq, filledParent mapping group ID
mapping_group_nameStringInputTypeeq, ilike, like, in, betweenParent mapping group name
created_atDatetimeInputTypeeq, from, to, betweenCreation timestamp
More fields and filters available via GraphQL introspection.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
query
string<textarea>
required

GraphQL query string

Example:

"query($filter: MappingFilterType) { mappings { all(filter: $filter) { edges { node { id mapping_group_id mapping_fields { id code value } } } } } }"

​
variables
object

Query variables including the filter object

Example:
{
  "filter": { "mapping_group_id": { "eq": "88" } }
}

Response

Successful GraphQL response

​
data
object

Query result data

​
errors
object[]

GraphQL errors, if any