Avetta Pegasus Scope Scope Competency Controller API

The pegasusScope_scope-competency-controller API from Avetta — 7 operation(s) for pegasusscope_scope-competency-controller.

Operations 8

PUT /api/v1/scope/{scopeId}/competency/integrate Integrate single competency 1 #
POST /api/v1/scope/{scopeId}/competency/integrate Integrate single competency #
GET /api/v1/scope/{scopeId}/competency Search competencies #
GET /api/v1/scope/{scopeId}/competency/{competencyId} Get competency 1 #
GET /api/v1/scope/{scopeId}/competency/{competencyId}/file-definition Get competency file definition #
GET /api/v1/scope/{scopeId}/competency/globals Get competency globals #
GET /api/v1/scope/{scopeId}/competency/extSysKey/{extSysKey}/idKey/{idKey} Get competency by client key #
GET /api/v1/scope/{scopeId}/competencies Get competencies #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-supplier-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-get-workflow-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-supplier-profiles-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-create-work-request-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-worker-open-work-requests-summary-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-1-0-0-get-work-request-questions-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-integrate-employee-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-employee-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-worker-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-competency-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-scope-permission-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-3-29-14-client-company-registration-resource-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-stats-schema-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-request-structure-refresh-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-request-structure-password-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-request-wmconnect-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/avetta/refs/heads/main/json-schema/avetta-sites-message-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/avetta:avetta-pegasusscope-scope-competency-controller-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

avetta-pegasusscope-scope-competency-controller-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Avetta Pegasus Scope Scope Competency Controller API
  version: APSO-1355
  x-logo:
    url: avetta_logo.png
  description: 'Operations tagged pegasusScope_scope-competency-controller across 2 of this provider''s published API definitions: avetta-pegasus-dist.json, avetta-pegasus-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: EPE (Test Environment)
  url: https://epe-onsitetrackeasy.com.au/onsite-rest
- description: Production
  url: https://secure.onsitetrackeasy.com.au/onsite-rest
tags:
- name: pegasusScope_scope-competency-controller
  x-displayName: scope-competency-controller
paths:
  /api/v1/scope/{scopeId}/competency/integrate:
    put:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: integrateSingleCompetency_1
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/3.29.14_ClientSingleCompetencyUpdateResource'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_CompetencyResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Integrate single competency 1
      x-summary-source: derived
    post:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: integrateSingleCompetency
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/3.29.14_ClientSingleCompetencyUpdateResource'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_CompetencyResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Integrate single competency
      x-summary-source: derived
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/competency:
    get:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: searchCompetencies
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: activeOnly
        in: query
        required: false
        schema:
          type: boolean
          default: true
      - name: includeDescendantScopes
        in: query
        required: false
        schema:
          type: boolean
          default: false
      - name: globalSearch
        in: query
        required: false
        schema:
          type: string
      - name: page.page
        in: query
        description: For results more than one page long, the page to load.
        schema:
          type: integer
          default: 0
      - name: page.size
        in: query
        description: The number of results to return per page
        schema:
          type: integer
          default: 20
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/3.29.14_CompetencyResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Search competencies
      x-summary-source: derived
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/competency/{competencyId}:
    get:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: getCompetency_1
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: competencyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_CompetencyResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Get competency 1
      x-summary-source: derived
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/competency/{competencyId}/file-definition:
    get:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: getCompetencyFileDefinition
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: competencyId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FileUploadRequirementResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Get competency file definition
      x-summary-source: derived
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/competency/globals:
    get:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: getCompetencyGlobals
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/3.29.14_CompetencyGlobalResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Get competency globals
      x-summary-source: derived
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/competency/extSysKey/{extSysKey}/idKey/{idKey}:
    get:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: getCompetencyByClientKey
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: extSysKey
        in: path
        required: true
        schema:
          type: string
      - name: idKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_CompetencyResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Get competency by client key
      x-summary-source: derived
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
  /api/v1/scope/{scopeId}/competencies:
    get:
      tags:
      - pegasusScope_scope-competency-controller
      operationId: getCompetencies
      parameters:
      - name: scopeId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: competencyIds
        in: query
        required: true
        schema:
          type: array
          items:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/3.29.14_CompetencyResource'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_FullErrorResource'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/3.29.14_ErrorResource'
      security:
      - 3.29.14_security_auth: []
        3.29.14_security_apikey: []
      summary: Get competencies
      x-summary-source: derived
    servers:
    - description: EPE (Test Environment)
      url: https://epe-onsitetrackeasy.com.au/onsite-rest
    - description: Production
      url: https://secure.onsitetrackeasy.com.au/onsite-rest
components:
  schemas:
    3.29.14_NaturalKeyResource:
      type: object
      properties:
        extSysKey:
          type: string
        idKey:
          type: string
    3.29.14_ClientSingleCompetencyUpdateResource:
      required:
      - clientExtSysKey
      - clientIdKey
      - description
      - duration
      - durationUnit
      - globalId
      - levelId
      - mandatoryCompetencySteps
      - scopeId
      - suffix
      - verifiedDocument
      - verifiedDocumentExpiryMandatory
      - verifiedDocumentIssueMandatory
      - verifiedDocumentPrivateFile
      type: object
      properties:
        id:
          type: integer
          format: int32
        scopeId:
          type: integer
          format: int32
        globalId:
          type: integer
          format: int32
        levelId:
          type: integer
          format: int32
        suffix:
          maxLength: 100
          minLength: 0
          type: string
        description:
          type: string
        duration:
          type: integer
          format: int32
        durationUnit:
          type: string
          enum:
          - Days
          - Weeks
          - Months
          - Years
        verifiedDocument:
          type: boolean
        verifiedDocumentPrivateFile:
          type: boolean
        verifiedDocumentSensitiveFile:
          type: boolean
        verifiedDocumentIssueMandatory:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        verifiedDocumentExpiryMandatory:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        nonVerifiedDocumentIssueMandatory:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        nonVerifiedDocumentExpiryMandatory:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        printOnSticker:
          type: boolean
        hideFileUpload:
          type: boolean
        mandatoryCompetencySteps:
          type: array
          items:
            type: string
            enum:
            - PERMIT_TO_TRAIN
            - TRAINED
            - TRAINED_TT
            - TRAINED_TP
            - TRAINED_TE
            - ASSESSED
            - AUTHORISED
            - APPOINTED
        active:
          type: boolean
        clientExtSysKey:
          maxLength: 255
          minLength: 0
          type: string
        clientIdKey:
          maxLength: 255
          minLength: 0
          type: string
    3.29.14_CompetencyLevelResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
    3.29.14_StatusType:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        reasonPhrase:
          type: string
    3.29.14_FileUploadRequirementResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        mandatoryStatus:
          type: string
          enum:
          - 'YES'
          - 'NO'
          - CONDITIONAL
        mandatoryConditionalText:
          type: string
        requirementsDescription:
          type: string
        helpLinkUrl:
          type: string
        fileType:
          type: string
        fileSizeBytes:
          type: integer
          format: int32
        mimetypes:
          uniqueItems: true
          type: array
          items:
            type: string
        downloadableDocId:
          type: integer
          format: int32
        allowOnlineAssessment:
          type: boolean
        issueDateMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        expiryDateMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
    3.29.14_ScopeDetailResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        timezone:
          type: string
        fatigueLimit:
          type: integer
          format: int32
        siteId:
          type: integer
          format: int32
        realmId:
          type: integer
          format: int32
        concoId:
          type: integer
          format: int32
        type:
          type: string
          enum:
          - SYSTEM
          - REALM
          - SITE
          - LOCATION
          - CONCO_WEB
          - EMPLOYEE
          - UNKNOWN
        typeDisplayName:
          type: string
        ownerName:
          type: string
        connectAccountId:
          type: string
        connectClient:
          type: boolean
        parentId:
          type: integer
          format: int32
        realm:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        site:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        conco:
          $ref: '#/components/schemas/3.29.14_KeyedIntegerResource'
        topLevel:
          type: boolean
    3.29.14_KeyedIntegerResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
    3.29.14_FullErrorResource:
      type: object
      properties:
        errorType:
          type: string
          enum:
          - GENERAL_ERROR
          - BAD_REQUEST
          - FORBIDDEN
          - UNAUTHORISED
          - NO_ACCESS_TO_PORTAL
          - INVALID_PASSWORD
          - NOT_FOUND
          - CONSTRAINT_VIOLATION
          - VALIDATION_ERROR
          - ALREADY_EXISTS
          - DATA_MISMATCH
          - NOT_AN_EMPLOYEE
          - CANNOT_BE_TERMINATED
          - TOO_MANY_FAILED_ATTEMPTS
          - REQUIRED_FIELD_MISSING
          - VERIFICATION_TOKEN_EXPIRED
          - PURCHASE_ORDER_EXPIRED
          - DUPLICATE_PAYMENT
          - PAYMENT_ERROR
          - CANNOT_BE_UPDATED
          - PENDING_CARD_IN_PROGRESS
          - CANNOT_ASSIGN
          - INVALID_PERSON_STATE
        error:
          type: string
        field:
          type: string
        problems:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_Problem'
        errorDetail:
          type: string
    3.29.14_CompetencyGlobalResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        levels:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_CompetencyLevelResource'
    3.29.14_CompetencyResource:
      type: object
      properties:
        stubId:
          type: integer
          format: int32
        competencyId:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
        duration:
          type: integer
          format: int32
        durationUnit:
          type: string
          enum:
          - Days
          - Weeks
          - Months
          - Years
        groupCompetency:
          type: boolean
        verifiedDocument:
          type: boolean
        allowTrainingBookings:
          type: boolean
        external:
          type: boolean
        active:
          type: boolean
        hideFileUpload:
          type: boolean
        externalId:
          $ref: '#/components/schemas/3.29.14_KeyedStringResource'
        clientKey:
          $ref: '#/components/schemas/3.29.14_NaturalKeyResource'
        scope:
          $ref: '#/components/schemas/3.29.14_ScopeDetailResource'
        suffix:
          type: string
        level:
          type: string
        global:
          type: string
        verifiedDocumentIssueMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        verifiedDocumentExpiryMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        nonVerifiedDocumentIssueMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        nonVerifiedDocumentExpiryMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        scopeId:
          type: integer
          format: int32
        fileUploadRequirement:
          $ref: '#/components/schemas/3.29.14_FileUploadRequirementResource'
        members:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_CompetencyResource'
        competencyRequirement:
          type: string
          enum:
          - MANDATORY
          - OPTIONAL
          - CONDITIONAL
        uploadAllowed:
          type: boolean
        deliveredByTraining:
          type: boolean
        issueDateMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        expiryDateMandatoryStatus:
          type: string
          enum:
          - NOT_ALLOWED
          - OPTIONAL
          - MANDATORY
        minimumValidityDaysBeforeRenewal:
          type: integer
          format: int32
    3.29.14_ErrorResource:
      type: object
      properties:
        errorType:
          type: string
          enum:
          - GENERAL_ERROR
          - BAD_REQUEST
          - FORBIDDEN
          - UNAUTHORISED
          - NO_ACCESS_TO_PORTAL
          - INVALID_PASSWORD
          - NOT_FOUND
          - CONSTRAINT_VIOLATION
          - VALIDATION_ERROR
          - ALREADY_EXISTS
          - DATA_MISMATCH
          - NOT_AN_EMPLOYEE
          - CANNOT_BE_TERMINATED
          - TOO_MANY_FAILED_ATTEMPTS
          - REQUIRED_FIELD_MISSING
          - VERIFICATION_TOKEN_EXPIRED
          - PURCHASE_ORDER_EXPIRED
          - DUPLICATE_PAYMENT
          - PAYMENT_ERROR
          - CANNOT_BE_UPDATED
          - PENDING_CARD_IN_PROGRESS
          - CANNOT_ASSIGN
          - INVALID_PERSON_STATE
        error:
          type: string
        field:
          type: string
        problems:
          type: array
          items:
            $ref: '#/components/schemas/3.29.14_Problem'
    3.29.14_Problem:
      type: object
      properties:
        instance:
          type: string
          format: uri
        type:
          type: string
          format: uri
        parameters:
          type: object
          additionalProperties:
            type: object
        detail:
          type: string
        title:
          type: string
        status:
          $ref: '#/components/schemas/3.29.14_StatusType'
    3.29.14_KeyedStringResource:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
  securitySchemes:
    3.29.14_security_auth:
      type: oauth2
      scheme: Bearer
      flows:
        authorizationCode:
          authorizationUrl: https://login.poweredbyonsite.com/cas/oidc/authorize
          tokenUrl: https://login.poweredbyonsite.com/cas/oidc/accessToken
          scopes:
            pegasus: Pegasus Authentication Scope
    3.29.14_security_apikey:
      type: apiKey
      name: api_key
      in: header
x-refined-from:
- avetta-pegasus-dist.json
- avetta-pegasus-openapi.yml
x-tagGroups:
- name: Compliance
  tags:
  - Authentication
  - Compliance
- name: Account
  tags:
  - Account
- name: Worksite Safety
  tags:
  - Worksite-Safety
- name: Deprecated Endpoints
  tags:
  - Deprecated Endpoints
  - Error Handling