Invotra API

Learn more about ‘Invotra’s API

What's New

The intranet wide update in January 2024 includes significant improvements and changes. 

In addition to there being new features and functionalities there have been some changes made to the actual API that we use at Invotra. In this document we will cover the key new areas that you need to be aware of around our new API and how it can benefit you as a user of the intranet.

Invotra’s API

Below is a list of all the different GraphQL API Endpoints, also known as tags/fields, that will be used in BART. 

 

These will all sit within the one API (GraphQL API) as opposed to Invotra having multiple separate API’s. Please see below a table containing all of our API endpoints and what their corresponding endpoint would have been in our old API Dev.Invotra (where applicable).

Dev.invotra (Swagger) (Old) → GraphQL API (New) Additional API Endpoints
Administration, Branding, File_types, Configuration  —> OrgConfig(…): OrgConfig  Activities (…): ActivityConnection
Badges —> Badge (…) Badge App (…): App
Files  —> MediaFile (…) MediaFile AppConfig(…): AppConfig
Feeds —> Activity (…): Activity  AppConfigs (…): AppConfigConnection
Layouts —> Layout (…) Layout AppRole (…) AppRole
Teams —> Team (…) Team AppRoles (…) AppRoleConnection
Get/Content/List —> Content (…): Content  Apps (…) AppConnection
Post/Group_Polls —> Poll (…): Poll Badges (…) BadgeConnection
Likes & Saved —> PollBehaviours: [PollBehaviour Instance!]! Comment Behaviours: [CommentBehaviour Insta…
Users —> User (…): User  Container (…) : Container
Titles —> UserTitle(…): UserTitle Containers (…): ContainerConnection
Post/Teams —> Team (…) Team ContentBehaviours: [ContentBehaviour Insta…
Feeds —> Activity (…): Activity  Contents (…): ContentConnection
Comments —> Comment (…): Comment  Employment Types (…): Employment TypeConnect…
Get/Administration —> Config(…) Config  Link (…) Link
Get/users/{user_id}/job_roles —> EmploymentType (…): EmploymentType Links (…) LinkConnection
Feeds —> Feed (…)  ManualPageBehaviours: Likes and saved
Notifications —> Inbox (…) Organisation (…): Organisation – doesn’t exist in the old product
Notifications —> NotificationConnection  Organisations (…):OrganisationConnection 
job_roles —> JobRole(…): JobRole PersonalInterest (…): /PersonalInterest
List(…) List → No longer exists PrivateComment (…): PrivateComment. /comments
location  —> Location (…) Location Report (…) Report //posts/{post_id}/report
Get/manuals  —> Manual (…) Manual  Schema (…) Schema
Likes and saved  → Manual Behaviours:[ManualBehaviour Instanc… Schemata (…) SchemaConnection
manual_pages  —> ManualPage(…): ManualPage SearchHighlight (…): /Search highlights
Files —> MediaFile (…) MediaFile Tag (…): Tag
site_sections —> Menu (…) : Menu  Tags (…): TagConnection
polls —> Poll (…): Poll Template (…): Template
Likes & Saved —> PollBehaviours: [PollBehaviour Instance!]! Templates (…): TemplateConnection
organisational_skills —> ProfessionalSkill(…): ProfessionalSkill Vocabularies (…): VocabularyConnection
Regions —> Region (…): Region Vocabulary (…): Vocabulary
Grades —> RoleGrade (…): RoleGrade Widget (…): Widget
Saved Search  —> Saved Search (…): WidgetStyle(…): WidgetStyle
Saved Search Connection  —> Saved Searches (…):  WidgetStyles (…): WidgetStyleConnection + Widgets (…): WidgetConnection
/users/search —> Search (…)  Workflow (…): /Content
/users/search —> SearchResults!
Get/users/me  —> SocialProfile (…): SocialProfile
free_skills —> SoftSkill(…): SoftSkill
webforms —> Webform (…) Webform
webforms  —> WebformSubmission (…): WebformSubmission
Groups → SocialContainer (…): /

 

API Endpoint and it’s description

Please see below a table providing an explanation to each API endpoint in Invotra’s intranet

     

    API Endpoint Description
    Activities (…): Activity connection The user profile activity. E.g. feed
    Activity (…): Activity The user profile activity. E.g. feed
    App (…): App Relating to the different apps we have in the product i.e. Ideas, Groups, Queries etc.
    AppConfig(…): AppConfig The config associated to the apps i.e. enable comments, if the app is enabled/disabled.
    AppConfigs (…): AppConfigConnection The config associated to the apps i.e. enable comments, if the app is enabled/disabled.
    AppRole (…) AppRole The different roles associated to the app i.e. App moderator, viewer etc.
    AppRoles (…) AppRoleConnection The different roles associated to the app i.e. App moderator, viewer etc.
    Apps (…) AppConnection The apps associated with the overall organisation
    Badge (…) Badge The badges in the product
    Badges (…) BadgeConnection The badges in the product
    Comment (…): Comment The comments that are in the product from users
    Comment Behaviours: [CommentBehaviour Insta… The likes, bookmarks & reporting associated to the comment
    Comments (…): CommentConnection The comments associated to the piece of content
    Config(…) Config The site admin i.e. branding, Broadcast, editable fields etc.
    Configs (…): ConfigConnection The site admin i.e. branding, Broadcast, editable fields etc.
    Container (…) : Container A containment of content types. – No longer being used
    Containers (…): ContainerConnection A containment of content types. – No longer being used
    Content (…): Content The content types on the intranet i.e. Manuals, News etc.
    ContentBehaviours: [ContentBehaviourInsta… The likes, bookmarks and reporting associated to that content
    Contents (…): ContentConnection The content types on the intranet i.e. Manuals, News etc.
    EmploymentType (…): EmploymentType Ask Brendan – employment type of a user
    Employment Types (…): Employment TypeConnect… ^^^
    Feed (…) The feed for a given user
    FeedItemConnection The feed for a given user
    Inbox (…) Notifications for a given user 
    NotificationConnection Notifications for a given user 
    JobRole(…): JobRole The job roles for a user 
    JobRoles (…): JobRoleConnection The job roles for a user 
    Layout (…) Layout The layouts for a display for a content or menu
    Layouts (…): LayoutConnection The layouts for a display for a content or menu
    Link (…) Link The link is associated to the given list
    Links (…) LinkConnection The link is associated to the given list
    List(…) List A content type where users are able to list links, content & menus
    Lists (…): ListConnection A content type where users are able to list links, content & menus
    Location (…) Location The location that can be added to the intranet
    Locations (…): LocationConnection The location that can be added to the intranet
    Manual (…) Manual The Manual content type
    Manual Behaviours: [ManualBehaviour Instanc… The likes, bookmarks & reporting associated to the given manual
    ManualPage(…): ManualPage The Manual page content type associated to the Manual
    ManualPageBehaviours: [ManualPageBehaviou… The likes, bookmarks & reporting associated to the given manual page
    ManualPages (…): ManualPageConnection The Manual page content type associated to the Manual
    Manuals (…): ManualConnection The Manual page content type associated to the Manual
    MediaFile (…) MediaFile The files within the intranet
    MediaFileStatus(…): Boolean The status of the upload of the file
    MediaFiles (…): MediaFileConnection The files within the intranet
    Menu (…) : Menu The menus on the intranet formerly known as site sections
    Menus (…) MenuConnection The menus on the intranet formerly known as site sections
    OrgConfig(…): OrgConfig The site admin i.e. branding, Broadcast, editable fields etc. Associated with the intranet.
    OrgConfigs (…): OrgConfigConnection The site admin i.e. branding, Broadcast, editable fields etc. Associated with the intranet.
    Organisation (…): Organisation Where all users and content lives under
    Organisations (…): OrganisationConnection Where all users and content lives under
    PersonalInterest (…): PersonalInterest Personal interests that are associated with the user.
    PersonalInterests (…): PersonalInterestCon….. Personal interests that are associated with the user.
    Poll (…): Poll The Poll content type
    PollBehaviours: [PollBehaviour Instance!]! The likes, bookmarks & reporting associated to that Poll
    Polls (…) PollConnection The Poll content type
    PrivateComment (…): PrivateComment Comments that are private – looking to be redundant
    PrivateComments (…): PrivateCommentConnect… Comments that are private – looking to be redundant
    ProfessionalSkill(…): ProfessionalSkill Professional skills associated to the user – formerly known as soft skills in the old product
    ProfessionalSkills (…): ProfessionalSkillc… Professional skills associated to the user – formerly known as soft skills in the old product
    Region (…): Region The regions associated with the intranet
    Regions (…): RegionConnection The regions associated with the intranet
    Report (…) Report The reported comments and content
    Reports (…) ReportConnection The reported comments and content
    RoleGrade (…): RoleGrade The role grade associated with the user
    RoleGrades (…): RoleGradeConnection The role grade associated with the user
    Saved Search (…): Saved Search Saved searches for the given user
    Saved Searches (…): Saved  Saved searches for the given user
    SearchConnection The global search for the intranet
    Schema (…) Schema The schema definition for entities that have schema – relates to content i.e. the fields
    Schemata (…) SchemaConnection The schema definition for entities that have schema – relates to content i.e. the fields
    Search (…) The global search for the intranet
    SearchResults! The list of results that a user is presented with when using the search function
    SearchHighlight (…): SearchHighlight Within Admin you can configure search highlights that can then appear in the search functionality
    SearchHighlights (…): SearchHighlightConne… Within Admin you can configure search highlights that can then appear in the search functionality
    SocialContainer (…): SocialContainer Groups on the intranet – app
    SocialContainers (…): SocialContainerConne… Groups on the intranet – app
    SocialProfile (…): SocialProfile The social fields within the users profile i.e. Facebook, X etc.
    SocialProfiles (…): SocialProfileConnection The social fields within the users profile i.e. Facebook, X etc.
    SoftSkill(…): SoftSkill Soft skills have now been replaced with professional skills
    SoftSkills (…): SoftSkillConnection Soft skills have now been replaced with professional skills
    Tag (…): Tag Can be added to content in order to be filtered via by a user
    Tags (…): TagConnection Can be added to content in order to be filtered via by a user
    Task(…): Task Relating to CommsGrid (tasks within it)
    Tasks (…): TaskConnection Relating to CommsGrid (tasks within it)
    Team (…) Team A group of users on the intranet that are classed in the same ‘Team’
    Teams (…) TeamConnection A group of users on the intranet that are classed in the same ‘Team’
    Template (…): Template Content and Menu templates for the layout, widgets etc.
    Templates (…): TemplateConnection Content and Menu templates for the layout, widgets etc.
    User (…): User A member on the organisations intranet that has select permissions
    UserTitle(…): UserTitle The users pronouns displayed on their profile
    UserTitles (…): UserTitleConnection The users pronouns displayed on their profile
    Users (…): UserConnection The users role being shown within the title on the intranet
    Vocabularies (…): VocabularyConnection Across the site 
    Vocabulary (…): Vocabulary Relating to a tag. Tag = UK Vocabulary = england, scotland etc.
    Webform (…) Webform A form content type on the intranet
    WebformSubmission (…): WebformSubmission The submission of the webform content type
    WebformSubmissions (…): WebformSubmissionC…  The submission of the webform content type
    Webforms (…): WebformConnection A form content type on the intranet
    Widget (…): Widget The different interactions that a user can have on an intranets page/section
    WidgetStyle(…): WidgetStyle The additional styles that you can display for that widget
    WidgetStyles (…): WidgetStyleConnection + The additional styles that you can display for that widget
    Widgets (…): WidgetConnection The different interactions that a user can have on an intranets page/section
    Workflow (…): Workflow Different states that you can set for content i.e. Draft, Published, needs review etc.
    Workflows (…): WorkflowConnection Different states that you can set for content i.e. Draft, Published, needs review etc.
    listOrganisationMembershipInvites (…): Inv… listSocialContainer MembershipInvites (…): I. Lists the invitations for users of the intranet.

    Couldn't find what you're looking for?

    We're here to help. Please raise a support request via our help desk and we'll get back to you asap