Factset IRN API v1 — Custom Symbol Types

naftiko: 1.0.0-alpha2
info:
  label: Factset IRN API v1 — Custom Symbol Types
  description: 'Factset IRN API v1 — Custom Symbol Types. 7 operations. Lead operation: Factset Get all the custom symbol
    types. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Custom Symbol Types
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: irn-configuration-custom-symbol-types
    baseUri: https://api.factset.com/research/irn
    description: Factset IRN API v1 — Custom Symbol Types business capability. Self-contained, no shared references.
    resources:
    - name: v1-custom-symbol-types
      path: /v1/custom-symbol-types
      operations:
      - name: getcustomsymboltypes
        method: GET
        description: Factset Get all the custom symbol types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcustomsymboltype
        method: POST
        description: Factset Create a Custom symbol type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbol-types-reorder
      path: /v1/custom-symbol-types/reorder
      operations:
      - name: updatecustomsymboltypeorder
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-custom-symbol-types-customSymbolTypeId
      path: /v1/custom-symbol-types/{customSymbolTypeId}
      operations:
      - name: getcustomsymboltype
        method: GET
        description: Factset Get a specific Custom symbol type's details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolTypeId
          in: path
          type: string
          description: customSymbolTypeId to get associated record
          required: true
      - name: updatecustomsymboltype
        method: PUT
        description: Factset Edit a Custom symbol type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolTypeId
          in: path
          type: string
          description: customSymbolTypeId to update associated record
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecustomsymboltypeasync
        method: DELETE
        description: Factset Delete a Custom symbol type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolTypeId
          in: path
          type: string
          description: customSymbolTypeId to delete associated record
          required: true
    - name: v1-custom-symbol-types-customSymbolTypeId-custom-fields
      path: /v1/custom-symbol-types/{customSymbolTypeId}/custom-fields
      operations:
      - name: getsymbolcustomfieldsforcustomsymboltype
        method: GET
        description: Factset Get Custom fields for Custom Symbol type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customSymbolTypeId
          in: path
          type: string
          description: customSymbolTypeId to get associated Custom fileds
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-configuration-custom-symbol-types-rest
    port: 8080
    description: REST adapter for Factset IRN API v1 — Custom Symbol Types. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/custom-symbol-types
      name: v1-custom-symbol-types
      description: REST surface for v1-custom-symbol-types.
      operations:
      - method: GET
        name: getcustomsymboltypes
        description: Factset Get all the custom symbol types
        call: irn-configuration-custom-symbol-types.getcustomsymboltypes
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomsymboltype
        description: Factset Create a Custom symbol type
        call: irn-configuration-custom-symbol-types.createcustomsymboltype
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbol-types/reorder
      name: v1-custom-symbol-types-reorder
      description: REST surface for v1-custom-symbol-types-reorder.
      operations:
      - method: POST
        name: updatecustomsymboltypeorder
        description: updatecustomsymboltypeorder
        call: irn-configuration-custom-symbol-types.updatecustomsymboltypeorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbol-types/{customsymboltypeid}
      name: v1-custom-symbol-types-customsymboltypeid
      description: REST surface for v1-custom-symbol-types-customSymbolTypeId.
      operations:
      - method: GET
        name: getcustomsymboltype
        description: Factset Get a specific Custom symbol type's details
        call: irn-configuration-custom-symbol-types.getcustomsymboltype
        with:
          customSymbolTypeId: rest.customSymbolTypeId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomsymboltype
        description: Factset Edit a Custom symbol type
        call: irn-configuration-custom-symbol-types.updatecustomsymboltype
        with:
          customSymbolTypeId: rest.customSymbolTypeId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomsymboltypeasync
        description: Factset Delete a Custom symbol type
        call: irn-configuration-custom-symbol-types.deletecustomsymboltypeasync
        with:
          customSymbolTypeId: rest.customSymbolTypeId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/custom-symbol-types/{customsymboltypeid}/custom-fields
      name: v1-custom-symbol-types-customsymboltypeid-custom-fields
      description: REST surface for v1-custom-symbol-types-customSymbolTypeId-custom-fields.
      operations:
      - method: GET
        name: getsymbolcustomfieldsforcustomsymboltype
        description: Factset Get Custom fields for Custom Symbol type
        call: irn-configuration-custom-symbol-types.getsymbolcustomfieldsforcustomsymboltype
        with:
          customSymbolTypeId: rest.customSymbolTypeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-configuration-custom-symbol-types-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset IRN API v1 — Custom Symbol Types. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: factset-get-all-custom-symbol
      description: Factset Get all the custom symbol types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-custom-symbol-types.getcustomsymboltypes
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-custom-symbol-type
      description: Factset Create a Custom symbol type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-configuration-custom-symbol-types.createcustomsymboltype
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: updatecustomsymboltypeorder
      description: updatecustomsymboltypeorder
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-configuration-custom-symbol-types.updatecustomsymboltypeorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-specific-custom-symbol
      description: Factset Get a specific Custom symbol type's details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-custom-symbol-types.getcustomsymboltype
      with:
        customSymbolTypeId: tools.customSymbolTypeId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-custom-symbol-type
      description: Factset Edit a Custom symbol type
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-configuration-custom-symbol-types.updatecustomsymboltype
      with:
        customSymbolTypeId: tools.customSymbolTypeId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-custom-symbol-type
      description: Factset Delete a Custom symbol type
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-configuration-custom-symbol-types.deletecustomsymboltypeasync
      with:
        customSymbolTypeId: tools.customSymbolTypeId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-custom-fields-custom
      description: Factset Get Custom fields for Custom Symbol type
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-custom-symbol-types.getsymbolcustomfieldsforcustomsymboltype
      with:
        customSymbolTypeId: tools.customSymbolTypeId
      outputParameters:
      - type: object
        mapping: $.