Factset IRN API v1 — Relationships

naftiko: 1.0.0-alpha2
info:
  label: Factset IRN API v1 — Relationships
  description: 'Factset IRN API v1 — Relationships. 4 operations. Lead operation: Factset Get list of the relationships configured
    in your group. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - 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-configuration-relationships-2
    baseUri: https://api.factset.com/research/irn
    description: Factset IRN API v1 — Relationships business capability. Self-contained, no shared references.
    resources:
    - name: v1-relationships
      path: /v1/relationships
      operations:
      - name: getrelationships
        method: GET
        description: Factset Get list of the relationships configured in your group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
      - name: createcontactrelationshiptype
        method: POST
        description: Factset Create a relationship type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-relationships-relationshipId
      path: /v1/relationships/{relationshipId}
      operations:
      - name: editrelationship
        method: PUT
        description: Factset Edit a relationship type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: relationshipId
          in: path
          type: string
          description: relationshipId to update associated record
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleterelationship
        method: DELETE
        description: Factset Delete a relationship type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: relationshipId
          in: path
          type: string
          description: relationshipId to delete associated record
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-configuration-relationships-2-rest
    port: 8080
    description: REST adapter for Factset IRN API v1 — Relationships. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/relationships
      name: v1-relationships
      description: REST surface for v1-relationships.
      operations:
      - method: GET
        name: getrelationships
        description: Factset Get list of the relationships configured in your group
        call: irn-configuration-relationships-2.getrelationships
        with:
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcontactrelationshiptype
        description: Factset Create a relationship type
        call: irn-configuration-relationships-2.createcontactrelationshiptype
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/relationships/{relationshipid}
      name: v1-relationships-relationshipid
      description: REST surface for v1-relationships-relationshipId.
      operations:
      - method: PUT
        name: editrelationship
        description: Factset Edit a relationship type
        call: irn-configuration-relationships-2.editrelationship
        with:
          relationshipId: rest.relationshipId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterelationship
        description: Factset Delete a relationship type
        call: irn-configuration-relationships-2.deleterelationship
        with:
          relationshipId: rest.relationshipId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-configuration-relationships-2-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset IRN API v1 — Relationships. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-get-list-relationships-configured
      description: Factset Get list of the relationships configured in your group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-relationships-2.getrelationships
      with:
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-relationship-type
      description: Factset Create a relationship type
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-configuration-relationships-2.createcontactrelationshiptype
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-relationship-type
      description: Factset Edit a relationship type
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-configuration-relationships-2.editrelationship
      with:
        relationshipId: tools.relationshipId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-relationship-type
      description: Factset Delete a relationship type
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-configuration-relationships-2.deleterelationship
      with:
        relationshipId: tools.relationshipId
      outputParameters:
      - type: object
        mapping: $.