Issue Tracker API

  • SECTIONS
  • Overview
  • API Definition
  • Changelog
Overview

Issue Tracker is a client facing ticketing systems of FactSet. Which is used by Factset clients to file issues with different products as well as request help.

Issue Tracker API allows users programmatically Create, Read and Update the issues which the serial has access to.

Please contact FactSet team for Product and catgory lookup data.

Key Features:

Ticket Creation and Updating: Clients can create Issue Tracker tickets and add new comments to existing ones. The system allows for modifying basic issue properties. Attachments: Users can upload attachments to the Issue Tracker and use them in messages related to the issue.

Available Endpoints:

Issues:

/issues: endpoint allows the creation of Issue Tracker tickets and generates a unique global issue ID. This ID can be used for retrieval and updates via the GET and PATCH endpoints. /issues/{id}: Provides GET and PATCH methods to retrieve ticket details, such as the subject, severity, internal RPD ID, and comments, or to update issue properties like the subject, severity, and product information. /issues/{id}/comments: Enables adding new comments to a specific ticket.

Attachments:

/attachments endpoint allows users to upload attachments that can be linked to an Issue Tracker ticket. /attachments/{id}/name endpoint enables attachments viewing in a browser and is used in issue comments. /attachment/file-extentions gives infomation about what file types issue tracker allows for attachments.

Key Notes:

When an issue contains attachments, the Issue Tracker API provides only the relative path to each attachment. If a client attempts to navigate to an attachment directly, the link will resolve relative to the client’s domain. For instance, if the client is located at https://www.example.com/foo/bar/issues/, clicking an attachment link will redirect to https://www.example.com/foo/bar/issues/attachments. To ensure proper handling of attachment links, developers integrating with the Issue Tracker API need to configure a dedicated route for attachments. This new route should make an authenticated GET request to the Issue Tracker API to retrieve attachments, following proper API authentication protocols.

Why Use the Issue Tracker API?

Flexible Integration: The API offers a consistent experience across all FactSet APIs, adheres to industry standards, and supports versioning, ensuring smooth integration and scalability. Comprehensive Documentation: Extensive documentation is available on the FactSet Developer Portal, providing clear guidance on authentication, endpoint usage, and response formats to facilitate implementation.

For detailed instructions on how to use the Issue Tracker API, refer to the API Documentation section in the sidebar or at the bottom of this page.

API Definition
Changelog

v1

Summary

  • Version 1.0.0 – Released on 8-Jan-2024
  • Enabled Basic Issue Tracker API endpoint to Internet as per WHSS client request
  • Extended more features like posting comments.
  • Enabled new features like updating severity, title and category.

Functionality Additions

  • Added new atatchment endpoints of existing behavior[v1.3.0]
  • Put endpoint to update product or category of an existing issue[v1.2.0].
  • New Post endpoint to post comment on Issuetracker issue[v1.1.0].
  • New Patch endpoint which supports to change the serverity and subject of existing issue[v1.1.0].
  • Added new Get endpoint to fetch the details of matched issue[v1.0.0].
  • New Post endpoint to create issue tracker issue[v1.0.0].

Changes

  • New request model UpdateCategoryRequest was added [v1.2.0].
  • New model commentrequest to post the comment was added[v1.1.0]
  • New model issueRequest to create the issue was added[v1.0.0].

Bug Fixes

  • Minor bug fixes [v1.0.0]