Roles

Browse ONET occupational roles enriched with tasks, skills, abilities, technology skills, and crosswalk links to STIGs and NICE Work Roles. All /api/v1/roles endpoints require a SAMS token and the **ONET** product entitlement.

List roles

Return a paginated list of O*NET occupations with summary counts.

GET /api/v1/roles

Parameters

  • Name
    search
    Type
    string
    Description

    Filter by occupation title or O*NET code (case-insensitive).

  • Name
    family
    Type
    string
    Description

    Filter by O*NET occupation family.

  • Name
    page
    Type
    integer
    Description

    Page number (default: 1).

  • Name
    limit
    Type
    integer
    Description

    Items per page (default: 100, max: 150).

Response

Response

{
  "roles": [
    {
      "onetCode": "15-1212.00",
      "title": "Information Security Analysts",
      "occupationFamily": "Computer Specialist",
      "jobZone": 4,
      "taskCount": 42,
      "technologySkillCount": 15,
      "stigMappingCount": 8
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "total": 923,
    "totalPages": 10
  }
}

Get a role

Fetch a single O*NET occupation with full task, skill, ability, work-activity, education, and STIG-mapping detail.

GET /api/v1/roles/{code}

Parameters

  • Name
    code
    Type
    string
    Description

    O*NET-SOC code (e.g. 15-1212.00).

Response

Response

{
  "onetCode": "15-1212.00",
  "title": "Information Security Analysts",
  "description": "Plan, implement, upgrade, or monitor security measures...",
  "occupationFamily": "Computer Specialist",
  "jobZone": 4,
  "jobZoneName": "Considerable Preparation Needed",
  "tasks": [
    {
      "taskId": "1.A.1.a",
      "statement": "Monitor use of data files and regulate access...",
      "taskType": "Core"
    }
  ],
  "technologySkills": [
    {
      "title": "Splunk Enterprise",
      "example": "Splunk Enterprise Security",
      "hotTechnology": true,
      "inDemand": true
    }
  ],
  "skills": [
    {
      "elementId": "2.A.1.a",
      "name": "Critical Thinking",
      "scaleId": "IM",
      "value": 4.5
    }
  ],
  "abilities": [],
  "workActivities": [],
  "education": [],
  "stigMappings": [
    {
      "stigSlug": "windows-server-2022",
      "stigTitle": "Windows Server 2022 STIG",
      "stigVersion": "1",
      "releaseDate": "2024-09-13",
      "confidenceScore": 0.92,
      "relevanceRank": 1,
      "roleResponsibilityLevel": "Primary",
      "mappingSource": "automated",
      "mappingReason": "NICE Work Role match"
    }
  ]
}

Returns 404 if the O*NET code is not found.


Download a role

Download a complete role profile in JSON, CSV, or XML format.

GET /api/v1/roles/{code}/download

Parameters

  • Name
    code
    Type
    string
    Description

    O*NET-SOC code.

  • Name
    format
    Type
    string
    Description

    Export format: json (default), csv, or xml.

Response

{
  "onetCode": "15-1212.00",
  "title": "Information Security Analysts",
  "tasks": [...],
  "technologySkills": [...],
  "stigMappings": [...]
}