FactSet IRN Contacts API — Relationships

naftiko: 1.0.0-alpha2
info:
  label: FactSet IRN Contacts API — Relationships
  description: 'FactSet IRN Contacts API — Relationships. 6 operations. Lead operation: Factset Get All the Relationships
    Where the Given Symbol or Contact Identifier Has Been Tagged in a Relationship. 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-contacts-relationships
    baseUri: https://api.factset.com/research/irn
    description: FactSet IRN Contacts API — Relationships business capability. Self-contained, no shared references.
    resources:
    - name: v1-contact-relationships
      path: /v1/contact-relationships
      operations:
      - name: getallrelationshipstaggingacontact
        method: GET
        description: Factset Get All the Relationships Where the Given Symbol or Contact Identifier Has Been Tagged in a Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: symbol
          in: query
          type: string
        - name: contactId
          in: query
          type: string
        - name: relationshipId
          in: query
          type: string
      - name: createcontactrelationship
        method: POST
        description: Factset Create a Contact Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-contact-relationships-contactRelationshipId
      path: /v1/contact-relationships/{contactRelationshipId}
      operations:
      - name: getcontactrelationship
        method: GET
        description: Factset Get Details on a Specific Contact Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactRelationshipId
          in: path
          type: string
          description: contactRelationshipId to get associated record
          required: true
      - name: patchcontactrelationship
        method: PATCH
        description: Factset Update a Contact Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactRelationshipId
          in: path
          type: string
          description: contactRelationshipId to update associated record
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecontactrelationship
        method: DELETE
        description: Factset Delete a Contact Relationship
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactRelationshipId
          in: path
          type: string
          description: contactRelationshipId to delete associated record
          required: true
    - name: v1-contacts-contactId-relationships
      path: /v1/contacts/{contactId}/relationships
      operations:
      - name: getcontactrelationships
        method: GET
        description: Factset Returns a List of a Contacts Relationships
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactId
          in: path
          type: string
          description: contactId to get associated records
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-contacts-relationships-rest
    port: 8080
    description: REST adapter for FactSet IRN Contacts API — Relationships. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/contact-relationships
      name: v1-contact-relationships
      description: REST surface for v1-contact-relationships.
      operations:
      - method: GET
        name: getallrelationshipstaggingacontact
        description: Factset Get All the Relationships Where the Given Symbol or Contact Identifier Has Been Tagged in a Relationship
        call: irn-contacts-relationships.getallrelationshipstaggingacontact
        with:
          symbol: rest.symbol
          contactId: rest.contactId
          relationshipId: rest.relationshipId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcontactrelationship
        description: Factset Create a Contact Relationship
        call: irn-contacts-relationships.createcontactrelationship
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/contact-relationships/{contactrelationshipid}
      name: v1-contact-relationships-contactrelationshipid
      description: REST surface for v1-contact-relationships-contactRelationshipId.
      operations:
      - method: GET
        name: getcontactrelationship
        description: Factset Get Details on a Specific Contact Relationship
        call: irn-contacts-relationships.getcontactrelationship
        with:
          contactRelationshipId: rest.contactRelationshipId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchcontactrelationship
        description: Factset Update a Contact Relationship
        call: irn-contacts-relationships.patchcontactrelationship
        with:
          contactRelationshipId: rest.contactRelationshipId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontactrelationship
        description: Factset Delete a Contact Relationship
        call: irn-contacts-relationships.deletecontactrelationship
        with:
          contactRelationshipId: rest.contactRelationshipId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/contacts/{contactid}/relationships
      name: v1-contacts-contactid-relationships
      description: REST surface for v1-contacts-contactId-relationships.
      operations:
      - method: GET
        name: getcontactrelationships
        description: Factset Returns a List of a Contacts Relationships
        call: irn-contacts-relationships.getcontactrelationships
        with:
          contactId: rest.contactId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-contacts-relationships-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet IRN Contacts API — Relationships. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: factset-get-all-relationships-where
      description: Factset Get All the Relationships Where the Given Symbol or Contact Identifier Has Been Tagged in a Relationship
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-contacts-relationships.getallrelationshipstaggingacontact
      with:
        symbol: tools.symbol
        contactId: tools.contactId
        relationshipId: tools.relationshipId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-contact-relationship
      description: Factset Create a Contact Relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-contacts-relationships.createcontactrelationship
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-details-specific-contact
      description: Factset Get Details on a Specific Contact Relationship
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-contacts-relationships.getcontactrelationship
      with:
        contactRelationshipId: tools.contactRelationshipId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-update-contact-relationship
      description: Factset Update a Contact Relationship
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-contacts-relationships.patchcontactrelationship
      with:
        contactRelationshipId: tools.contactRelationshipId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-contact-relationship
      description: Factset Delete a Contact Relationship
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-contacts-relationships.deletecontactrelationship
      with:
        contactRelationshipId: tools.contactRelationshipId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-list-contacts-relationships
      description: Factset Returns a List of a Contacts Relationships
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-contacts-relationships.getcontactrelationships
      with:
        contactId: tools.contactId
      outputParameters:
      - type: object
        mapping: $.