Freshservice Data Model
Authentication Authentication can be done using one of the following two alternatives:
- Using the user log on code, password and company also used on the Freshservice website.
- Using an API key and company. Authentication using user log on code and password is recommended for general use. The company is the name before '.freshservice.com' in the URL used to log on to Freshservice in a browser. The API key can be found in the 'Edit Profile' page in Freshservice, as described on https://support.freshservice.com/support/solutions/articles/225435-where-can-i-find-my-api-key.
API Version The V2 API of Freshservice is used. V1 APIs can be accessed using NativePlatformScalarRequests.
Usage Limits Invantive SQL executes API calls to retrieve and upload data. The number of API calls allowed per hour depends on your Freshservice plan, API version and whether you have chosen for rate limits per minute (most recent) or hour (older). The V1 API default usage limit is 1.000 calls per hour. On V2 the limit is 3.000 (blossom, garden) or 5.000 (estate, forest) calls per hour. The new V2 limits are 100 (blossom), 200 (garden), 400 (estate) or 700 (forest) calls per minute. Increased limits can be purchased. Invantive SQL ensures that within your session the number of calls allowed per hour is not exceeded. To get an impression of how Invantive SQL translates into API calls, please query the data dictionary view 'sessionios', such as with 'select * from sessionios@datadictionary'.
Set up this platform in Invantive Cloud: https://cloud.invantive.com/freshservice
Text comparisons on this platform are case sensitive.
Platform
- Used from: Invantive Cloud and the Invantive products on your own computer or server.
- Kind: an application reached over its API.
- The data is partitioned, such as per company or administration.
- Data can be written as well as read.
- Invantive Cloud plans: Free for Exact Online, Free, Office for Entrepreneurs, Office for Accountants, Premium Finance, OEM.
- Status of the platform: https://updates.freshservice.com/.
Figures
| Figure | Count |
|---|---|
| Tables | 73 |
| Columns | 928 |
Data Model Poster
This data model declares no keys yet; the dotted relations are derived from column names.
On a table of the poster: plus and minus zoom, the arrow keys move, 0 fits.
The poster as text: tables per topic and their relations
Freshservice · Departments
AgentRoles, AgentWorkspaces, Agents, AssetSources, Assets, Changes, Contracts, Departments, Locations, Problems, PurchaseOrders, RecentTickets, Releases, Requesters, TicketsIncremental, Vendors
Freshservice · Workspaces
AgentGroups, Announcements, Applications, BusinessHours, CannedResponses, ProblemFormFields, Products, ServiceCategories, ServiceItems, SlaPolicies, SolutionCategories, Workspaces
CodeValues (without relations)
ApplicationStatuses, ApplicationTypes, ApprovalStatuses, ApprovalTypes, AssetImpacts, AssetUsageTypes, BackgroundJobStatuses, ChangeImpacts, ChangePriorities, ChangeRisks, ChangeStatuses, ChangeTypes, ConversationSourceTypes, CustomFieldTypes, LookupDatasources, OffboardingRequestStatuses, OnboardingRequestStatuses, ProductProcurementModes, ProductStatuses, ProjectPriorities, ProjectStatuses, ProjectTypes, ProjectVisibilities, ServiceRequestStages, SolutionFolderVisibilities, TicketPriorities, TicketSourceTypes, TicketStatuses
Freshservice (without relations)
AgentGroupMembers, AssetTypes, BusinessHourHolidays, CABs, ContractTypes, ProblemFormFieldChoices, ProjectTemplates, ProjectsNewGen, RelationshipTypes, Relationships, RequesterGroups, StatisticsIncremental
Native (without relations)
Views (without relations)
Relations
- AgentGroups → Workspaces (candidate): Derived from the column workspace_id.
- AgentRoles → Agents (candidate): Derived from the column agent_id.
- AgentWorkspaces → Agents (candidate): Derived from the column agent_id.
- Agents → Locations (candidate): Derived from the column location_id.
- Announcements → Workspaces (candidate): Derived from the column workspace_id.
- Applications → Workspaces (candidate): Derived from the column workspace_id.
- AssetSources → Assets (candidate): Derived from the column asset_id.
- Assets → Agents (candidate): Derived from the column agent_id.
- Assets → Departments (candidate): Derived from the column department_id.
- Assets → Locations (candidate): Derived from the column location_id.
- BusinessHours → Workspaces (candidate): Derived from the column workspace_id.
- CannedResponses → Workspaces (candidate): Derived from the column workspace_id.
- Changes → Agents (candidate): Derived from the column agent_id.
- Changes → Departments (candidate): Derived from the column department_id.
- Changes → Requesters (candidate): Derived from the column requester_id.
- Changes → Workspaces (candidate): Derived from the column workspace_id.
- Contracts → Requesters (candidate): Derived from the column requester_id.
- Contracts → Vendors (candidate): Derived from the column vendor_id.
- Contracts → Workspaces (candidate): Derived from the column workspace_id.
- ProblemFormFields → Workspaces (candidate): Derived from the column workspace_id.
- Problems → Agents (candidate): Derived from the column agent_id.
- Problems → Departments (candidate): Derived from the column department_id.
- Problems → Requesters (candidate): Derived from the column requester_id.
- PurchaseOrders → Departments (candidate): Derived from the column department_id.
- PurchaseOrders → Vendors (candidate): Derived from the column vendor_id.
- PurchaseOrders → Workspaces (candidate): Derived from the column workspace_id.
- RecentTickets → Departments (candidate): Derived from the column department_id.
- RecentTickets → Requesters (candidate): Derived from the column requester_id.
- RecentTickets → Workspaces (candidate): Derived from the column workspace_id.
- Releases → Agents (candidate): Derived from the column agent_id.
- Releases → Departments (candidate): Derived from the column department_id.
- Releases → Workspaces (candidate): Derived from the column workspace_id.
- Requesters → Locations (candidate): Derived from the column location_id.
- ServiceCategories → Workspaces (candidate): Derived from the column workspace_id.
- ServiceItems → Products (candidate): Derived from the column product_id.
- ServiceItems → Workspaces (candidate): Derived from the column workspace_id.
- SlaPolicies → Workspaces (candidate): Derived from the column workspace_id.
- SolutionCategories → Workspaces (candidate): Derived from the column workspace_id.
- TicketsIncremental → Departments (candidate): Derived from the column department_id.
- TicketsIncremental → Requesters (candidate): Derived from the column requester_id.
- TicketsIncremental → Workspaces (candidate): Derived from the column workspace_id.
Tables
Freshservice.CodeValues
- ApplicationStatuses: Domain ApplicationStatuses
- ApplicationTypes: Domain ApplicationTypes
- ApprovalStatuses: Domain ApprovalStatuses
- ApprovalTypes: Domain ApprovalTypes
- AssetImpacts: Domain AssetImpacts
- AssetUsageTypes: Domain AssetUsageTypes
- BackgroundJobStatuses: Domain BackgroundJobStatuses
- ChangeImpacts: Domain ChangeImpacts
- ChangePriorities: Domain ChangePriorities
- ChangeRisks: Domain ChangeRisks
- ChangeStatuses: Domain ChangeStatuses
- ChangeTypes: Domain ChangeTypes
- ConversationSourceTypes: Domain ConversationSourceTypes
- CustomFieldTypes: Domain CustomFieldTypes
- LookupDatasources: Domain LookupDatasources
- OffboardingRequestStatuses: Domain OffboardingRequestStatuses
- OnboardingRequestStatuses: Domain OnboardingRequestStatuses
- ProductProcurementModes: Domain ProductProcurementModes
- ProductStatuses: Domain ProductStatuses
- ProjectPriorities: Domain ProjectPriorities
- ProjectStatuses: Domain ProjectStatuses
- ProjectTypes: Domain ProjectTypes
- ProjectVisibilities: Domain ProjectVisibilities
- ServiceRequestStages: Domain ServiceRequestStages
- SolutionFolderVisibilities: Domain SolutionFolderVisibilities
- TicketPriorities: Domain TicketPriorities
- TicketSourceTypes: Domain TicketSourceTypes
- TicketStatuses: Domain TicketStatuses
Freshservice.Freshservice
- AgentGroupMembers: Agent Group Members
- AgentGroups: Agent Groups
- AgentRoles: Agent Roles
- AgentWorkspaces: Agent Workspaces
- Agents: Agents
- Announcements: Announcements
- Applications: Applications
- AssetSources: Asset Sources
- AssetTypes: Asset Types
- Assets: Assets
- BusinessHourHolidays: Business Hour Holidays
- BusinessHours: Business Hours
- CABs: CABs
- CannedResponses: Canned Responses
- Changes: Changes
- ContractTypes: Contract Types
- Contracts: Contracts
- Departments: Departments
- Locations: Locations
- ProblemFormFieldChoices: Problem Form Field Choices
- ProblemFormFields: Problem Form Fields
- Problems: Problems
- Products: Products
- ProjectTemplates: Project Templates
- ProjectsNewGen: Projects (New Gen)
- PurchaseOrders: Purchase Orders
- RecentTickets: Tickets (Recent)
- RelationshipTypes: Relationship Types
- Relationships: Relationships
- Releases: Releases
- RequesterGroupMembersById: Requester Group Members by Id
- RequesterGroups: Requester Groups
- Requesters: Requesters
- SearchTickets: Search Tickets
- ServiceCategories: Service Categories
- ServiceItems: Service Items
- SlaPolicies: SLA Policies
- SolutionCategories: Solution Categories
- StatisticsIncremental: Statistics on Incremental Tables
- Tickets: Tickets
- TicketsIncremental: Tickets (Incremental)
- Vendors: Vendors
- Workspaces: Workspaces
Freshservice.Native
- NATIVEPLATFORMSCALARREQUESTS: Native Platform Scalar Requests
Freshservice.Views
Attributes
The attributes of this platform are on the page Attributes.
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: