FactSet IRN Configuration API — Contacts

naftiko: 1.0.0-alpha2
info:
  label: FactSet IRN Configuration API — Contacts
  description: 'FactSet IRN Configuration API — Contacts. 3 operations. Lead operation: Factset Get a Specific Contact Custom
    Field''s Details. Self-contained Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Contacts
  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-contacts
    baseUri: https://api.factset.com/research/irn
    description: FactSet IRN Configuration API — Contacts business capability. Self-contained, no shared references.
    resources:
    - name: v1-contact-custom-fields-contactCustomFieldId
      path: /v1/contact-custom-fields/{contactCustomFieldId}
      operations:
      - name: getcontactcustomfield
        method: GET
        description: Factset Get a Specific Contact Custom Field's Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactCustomFieldId
          in: path
          type: string
          description: contactCustomFieldId to get associated record
          required: true
      - name: patchcontactcustomfield
        method: PATCH
        description: Factset Edit a Contact Custom Field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactCustomFieldId
          in: path
          type: string
          description: contactCustomFieldId to update associated record
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecontactcustomfield
        method: DELETE
        description: Factset Delete a Contact Custom Field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: contactCustomFieldId
          in: path
          type: string
          description: contactCustomFieldId to delete associated record
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-configuration-contacts-rest
    port: 8080
    description: REST adapter for FactSet IRN Configuration API — Contacts. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/contact-custom-fields/{contactcustomfieldid}
      name: v1-contact-custom-fields-contactcustomfieldid
      description: REST surface for v1-contact-custom-fields-contactCustomFieldId.
      operations:
      - method: GET
        name: getcontactcustomfield
        description: Factset Get a Specific Contact Custom Field's Details
        call: irn-configuration-contacts.getcontactcustomfield
        with:
          contactCustomFieldId: rest.contactCustomFieldId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchcontactcustomfield
        description: Factset Edit a Contact Custom Field
        call: irn-configuration-contacts.patchcontactcustomfield
        with:
          contactCustomFieldId: rest.contactCustomFieldId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecontactcustomfield
        description: Factset Delete a Contact Custom Field
        call: irn-configuration-contacts.deletecontactcustomfield
        with:
          contactCustomFieldId: rest.contactCustomFieldId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-configuration-contacts-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet IRN Configuration API — Contacts. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: factset-get-specific-contact-custom
      description: Factset Get a Specific Contact Custom Field's Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-contacts.getcontactcustomfield
      with:
        contactCustomFieldId: tools.contactCustomFieldId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-contact-custom-field
      description: Factset Edit a Contact Custom Field
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-configuration-contacts.patchcontactcustomfield
      with:
        contactCustomFieldId: tools.contactCustomFieldId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-contact-custom-field
      description: Factset Delete a Contact Custom Field
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-configuration-contacts.deletecontactcustomfield
      with:
        contactCustomFieldId: tools.contactCustomFieldId
      outputParameters:
      - type: object
        mapping: $.