Factset IRN API v1 — Symbol Relationships

naftiko: 1.0.0-alpha2
info:
  label: Factset IRN API v1 — Symbol Relationships
  description: 'Factset IRN API v1 — Symbol Relationships. 5 operations. Lead operation: Factset Create a symbol relationship.
    Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Symbol Relationships
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: irn-custom-symbols-symbol-relationships
    baseUri: https://api.factset.com/research/irn
    description: Factset IRN API v1 — Symbol Relationships business capability. Self-contained, no shared references.
    resources:
    - name: v1-symbol-relationships
      path: /v1/symbol-relationships
      operations:
      - name: createsymbolrelationship
        method: POST
        description: Factset Create a symbol relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-symbol-relationships-symbolId-relationships
      path: /v1/symbol-relationships/{symbolId}/relationships
      operations:
      - name: getsymbolrelationships
        method: GET
        description: Factset Returns a list of a symbol’s relationships
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbolId
          in: path
          type: string
          description: symbolId to get associated records
          required: true
    - name: v1-symbol-relationships-symbolRelationshipId
      path: /v1/symbol-relationships/{symbolRelationshipId}
      operations:
      - name: getsymbolrelationship
        method: GET
        description: Factset Get details on a specific symbol relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbolRelationshipId
          in: path
          type: string
          description: symbolRelationshipId to get associated record
          required: true
      - name: deletesymbolrelationship
        method: DELETE
        description: Factset Delete a symbol relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbolRelationshipId
          in: path
          type: string
          description: symbolRelationshipId to delete associated record
          required: true
    - name: v1-symbol-relationships-symbol
      path: /v1/symbol-relationships/{symbol}
      operations:
      - name: editandaddsymbolrelationship
        method: PUT
        description: Factset Edit a symbol relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbol
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-custom-symbols-symbol-relationships-rest
    port: 8080
    description: REST adapter for Factset IRN API v1 — Symbol Relationships. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/symbol-relationships
      name: v1-symbol-relationships
      description: REST surface for v1-symbol-relationships.
      operations:
      - method: POST
        name: createsymbolrelationship
        description: Factset Create a symbol relationship
        call: irn-custom-symbols-symbol-relationships.createsymbolrelationship
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/symbol-relationships/{symbolid}/relationships
      name: v1-symbol-relationships-symbolid-relationships
      description: REST surface for v1-symbol-relationships-symbolId-relationships.
      operations:
      - method: GET
        name: getsymbolrelationships
        description: Factset Returns a list of a symbol’s relationships
        call: irn-custom-symbols-symbol-relationships.getsymbolrelationships
        with:
          symbolId: rest.symbolId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/symbol-relationships/{symbolrelationshipid}
      name: v1-symbol-relationships-symbolrelationshipid
      description: REST surface for v1-symbol-relationships-symbolRelationshipId.
      operations:
      - method: GET
        name: getsymbolrelationship
        description: Factset Get details on a specific symbol relationship
        call: irn-custom-symbols-symbol-relationships.getsymbolrelationship
        with:
          symbolRelationshipId: rest.symbolRelationshipId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesymbolrelationship
        description: Factset Delete a symbol relationship
        call: irn-custom-symbols-symbol-relationships.deletesymbolrelationship
        with:
          symbolRelationshipId: rest.symbolRelationshipId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/symbol-relationships/{symbol}
      name: v1-symbol-relationships-symbol
      description: REST surface for v1-symbol-relationships-symbol.
      operations:
      - method: PUT
        name: editandaddsymbolrelationship
        description: Factset Edit a symbol relationship
        call: irn-custom-symbols-symbol-relationships.editandaddsymbolrelationship
        with:
          symbol: rest.symbol
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-custom-symbols-symbol-relationships-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset IRN API v1 — Symbol Relationships. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: factset-create-symbol-relationship
      description: Factset Create a symbol relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-custom-symbols-symbol-relationships.createsymbolrelationship
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-list-symbol-s-relationships
      description: Factset Returns a list of a symbol’s relationships
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbol-relationships.getsymbolrelationships
      with:
        symbolId: tools.symbolId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-details-specific-symbol
      description: Factset Get details on a specific symbol relationship
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbol-relationships.getsymbolrelationship
      with:
        symbolRelationshipId: tools.symbolRelationshipId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-symbol-relationship
      description: Factset Delete a symbol relationship
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-custom-symbols-symbol-relationships.deletesymbolrelationship
      with:
        symbolRelationshipId: tools.symbolRelationshipId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-symbol-relationship
      description: Factset Edit a symbol relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-custom-symbols-symbol-relationships.editandaddsymbolrelationship
      with:
        symbol: tools.symbol
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.