taxonomyConcepts

Get taxonomy concepts based on multiple filters.

---

Arguments

input TaxonomyConceptsInput! Required

Filters and other information to use to find taxonomy concepts.

conceptTypeFilter TaxonomyConceptType

Filter by the type of taxonomy concept. If empty, the query returns concepts based on the other given filters. If all filters are empty, the query throws an error.

conceptIdFilter [ID!]! Required

Filter taxonomy concepts by SUID and/or UUID. If empty, the query returns concepts based on the other given filters. If all filters are empty, the query throws an error.

customClassFilter CustomClassFilterInput! Required

Filter taxonomy concepts by custom class. If empty, the query returns concepts based on the other given filters. If all filters are empty, the query throws an error.

customClasses [ID!]! Required

SUIDs of the custom classes by which to filter the taxonomy concepts.

operation CustomClassFilterOperation

Operation to use when filtering by custom class. The default is AND.

global Boolean default:false

Set to true to include taxonomy concepts that don't apply to the given country and language codes.

countryCode CountryCode

A 2-character country code. The value is encoded as an ISO 3166-1 alpha-2 formatted string.

The query only returns taxonomy concepts that apply to this country code. If you don't provide a country code, the query infers the country code based on the HTTP header and other information.

languageCode LanguageCode

A 2-character language code. The value is encoded as an ISO 639-1 formatted string.

The query only returns taxonomy concepts that apply to this language code. If you don't provide a language code, the query infers the language code based on the HTTP header and other information.

includeDeprecated Boolean

Set to true to keep TaxonomyConcepts that are deprecated.

Response

Returns TaxonomyConceptsPayload .

taxonomyConcepts [TaxonomyConcept!]

The filtered taxonomy concepts.

key ID! Non-Null

Short Unique Identifier (SUID) of the taxonomy concept. Used as the primary key.

uuid ID! Non-Null

Universal Unique Identifier (UUID) of the taxonomy concept. Prefer key over this value.

label String! Non-Null

Preferred label of the taxonomy concept.

Example: "Business etiquette"

alternativeLabels [String!]! Non-Null

Alternative labels of the taxonomy concept.

Example: "Business manner"

mobileLabel String! Non-Null

Display (user-facing) label of the taxonomy concept.

definitions [String!]! Non-Null

Definitions of the taxonomy concept.

pathToRoot [TaxonomyConcept!]! Non-Null

Path from this taxonomy concept to the root in the taxonomy tree.

key ID! Non-Null

Short Unique Identifier (SUID) of the taxonomy concept. Used as the primary key.

uuid ID! Non-Null

Universal Unique Identifier (UUID) of the taxonomy concept. Prefer key over this value.

label String! Non-Null

Preferred label of the taxonomy concept.

Example: "Business etiquette"

alternativeLabels [String!]! Non-Null

Alternative labels of the taxonomy concept.

Example: "Business manner"

mobileLabel String! Non-Null

Display (user-facing) label of the taxonomy concept.

definitions [String!]! Non-Null

Definitions of the taxonomy concept.

pathToRoot [TaxonomyConcept!]! Non-Null

Path from this taxonomy concept to the root in the taxonomy tree.

children [TaxonomyConcept!]! Non-Null

Direct children of the taxonomy concept in the taxonomy tree.

customClasses [CustomTaxonomyClass!]! Non-Null

Custom classes that the taxonomy concept belongs to.

Example: "Cross-Occupational Cluster"

taxonomyConceptType TaxonomyConceptType! Non-Null

Type of the taxonomy concept.

isVerifiedJobAttribute Boolean! Non-Null

Indicates whether the taxonomy concept is a verified attribute for jobs. Only request this field when taxonomyConceptType is ATTRIBUTE.

isVerifiedResumeAttribute Boolean! Non-Null

Indicates whether the taxonomy concept is a verified attribute for resumes. Only request this field if taxonomyConceptType is ATTRIBUTE.

children [TaxonomyConcept!]! Non-Null

Direct children of the taxonomy concept in the taxonomy tree.

key ID! Non-Null

Short Unique Identifier (SUID) of the taxonomy concept. Used as the primary key.

uuid ID! Non-Null

Universal Unique Identifier (UUID) of the taxonomy concept. Prefer key over this value.

label String! Non-Null

Preferred label of the taxonomy concept.

Example: "Business etiquette"

alternativeLabels [String!]! Non-Null

Alternative labels of the taxonomy concept.

Example: "Business manner"

mobileLabel String! Non-Null

Display (user-facing) label of the taxonomy concept.

definitions [String!]! Non-Null

Definitions of the taxonomy concept.

pathToRoot [TaxonomyConcept!]! Non-Null

Path from this taxonomy concept to the root in the taxonomy tree.

children [TaxonomyConcept!]! Non-Null

Direct children of the taxonomy concept in the taxonomy tree.

customClasses [CustomTaxonomyClass!]! Non-Null

Custom classes that the taxonomy concept belongs to.

Example: "Cross-Occupational Cluster"

taxonomyConceptType TaxonomyConceptType! Non-Null

Type of the taxonomy concept.

isVerifiedJobAttribute Boolean! Non-Null

Indicates whether the taxonomy concept is a verified attribute for jobs. Only request this field when taxonomyConceptType is ATTRIBUTE.

isVerifiedResumeAttribute Boolean! Non-Null

Indicates whether the taxonomy concept is a verified attribute for resumes. Only request this field if taxonomyConceptType is ATTRIBUTE.

customClasses [CustomTaxonomyClass!]! Non-Null

Custom classes that the taxonomy concept belongs to.

Example: "Cross-Occupational Cluster"

key ID! Non-Null

SUID of this custom class. Used as the primary key.

uuid ID! Non-Null

UUID of this custom class. Prefer key over this value.

label String! Non-Null

Preferred label of the custom class. This field is in English and is not localized.

taxonomyConceptType TaxonomyConceptType! Non-Null

Type of the taxonomy concept.

isVerifiedJobAttribute Boolean! Non-Null

Indicates whether the taxonomy concept is a verified attribute for jobs. Only request this field when taxonomyConceptType is ATTRIBUTE.

isVerifiedResumeAttribute Boolean! Non-Null

Indicates whether the taxonomy concept is a verified attribute for resumes. Only request this field if taxonomyConceptType is ATTRIBUTE.

transactionId ID! Non-Null

Unique transaction ID for the request used for debugging and analysis.

responseStatus MdsResponseStatus! Non-Null

Response status returned by the Occupational Metadata API.

responseCode MdsResponseCode! Non-Null

The response code returned by the Occupational Metadata API, which aligns with the standard GraphQL response codes.

errorMessage String

Description of any errors returned by the Occupational Metadata API.

Example

Query

query TaxonomyConcepts($input: TaxonomyConceptsInput!) {
  taxonomyConcepts(input: $input) {
    taxonomyConcepts {
      key
      uuid
      label
      alternativeLabels
      mobileLabel
      definitions
      pathToRoot {
        key
        uuid
        label
        alternativeLabels
        mobileLabel
        definitions
        pathToRoot {
          key
          uuid
          label
          alternativeLabels
          mobileLabel
          definitions
          pathToRoot {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          children {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          customClasses {
            key
            uuid
            label
          }
          taxonomyConceptType
          isVerifiedJobAttribute
          isVerifiedResumeAttribute
        }
        children {
          key
          uuid
          label
          alternativeLabels
          mobileLabel
          definitions
          pathToRoot {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          children {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          customClasses {
            key
            uuid
            label
          }
          taxonomyConceptType
          isVerifiedJobAttribute
          isVerifiedResumeAttribute
        }
        customClasses {
          key
          uuid
          label
        }
        taxonomyConceptType
        isVerifiedJobAttribute
        isVerifiedResumeAttribute
      }
      children {
        key
        uuid
        label
        alternativeLabels
        mobileLabel
        definitions
        pathToRoot {
          key
          uuid
          label
          alternativeLabels
          mobileLabel
          definitions
          pathToRoot {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          children {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          customClasses {
            key
            uuid
            label
          }
          taxonomyConceptType
          isVerifiedJobAttribute
          isVerifiedResumeAttribute
        }
        children {
          key
          uuid
          label
          alternativeLabels
          mobileLabel
          definitions
          pathToRoot {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          children {
            key
            uuid
            label
            alternativeLabels
            mobileLabel
            definitions
            pathToRoot {
              ...TaxonomyConceptFragment
            }
            children {
              ...TaxonomyConceptFragment
            }
            customClasses {
              ...CustomTaxonomyClassFragment
            }
            taxonomyConceptType
            isVerifiedJobAttribute
            isVerifiedResumeAttribute
          }
          customClasses {
            key
            uuid
            label
          }
          taxonomyConceptType
          isVerifiedJobAttribute
          isVerifiedResumeAttribute
        }
        customClasses {
          key
          uuid
          label
        }
        taxonomyConceptType
        isVerifiedJobAttribute
        isVerifiedResumeAttribute
      }
      customClasses {
        key
        uuid
        label
      }
      taxonomyConceptType
      isVerifiedJobAttribute
      isVerifiedResumeAttribute
    }
    transactionId
    responseStatus {
      responseCode
      errorMessage
    }
  }
}

Variables

{"input": TaxonomyConceptsInput}

Response

{
  "data": {
    "taxonomyConcepts": {
      "taxonomyConcepts": [TaxonomyConcept],
      "transactionId": "opaqueId",
      "responseStatus": MdsResponseStatus
    }
  }
}

 

Was this page helpful?