BulkData Ideas API Endpoint : Helpdesk

In This Article

Overview

You can access and export your Initiatives data by using the BulkIdeas API endpoint. To have the ability to export this data,

ensure your Role has the permission to Export Initiative data to be able to use the API. You can navigate to Administration > Roles > select your role > under Permissions, select Export Initiatives

BulkIdeas API Endpoint

You can obtain your BulkIdeas API Endpoint by using Swagger (for more information on how to access Swagger, kindly see the following article: How to find the available API Endpoints). Once you have entered the URL, select the BulkIdeas endpoint under BulkData to view the available parameters.

The following is required for the BulkIdeas API Endpoint (see below as example):

Your site URL
Your FromDate parameter which you require for data to be returned for
Your ToDate parameter which you require for data to be returned for
Your API key (for more information on how to obtain your API key, kindly see the following article: How to access you API Key)

Note: The FromDate and ToDate parameter should be in the format yyyy-MM-ddTHH:mm:ssZ

BulkIdeas Available API Parameters

These are the current available parameters for BulkIdeas:

SiteId
FromDate (compulsory)
ToDate (compulsory)
IncludeIdeas
IncludeActiveIdeas
IncludeApprovedIdeas
IncludeOnHoldIdeas
IncludeCancelledIdeas
IncludeCompletedIdeas
IncludeArchivedIdeas
IncludeConceptIdeas
IncludeActions
IncludeRisks
IncludeTrackings
IncludeInvestments
IncludeStakeholders
IncludeIdeaNotes
IncludeWorkflows
IncludeWorkflowNotes
IncludeOwnerReviews
IncludeAccess
IncludeAuditlogs
IncludeFinancials
IncludeForecasts
IncludeOwnerReviewActions

Once your desired parameters have been selected, i.e. by setting the parameter as True, click the Execute button located at the bottom to obtain your API endpoint and observe your results.

The requirement for the FromDate and ToDate parameters currently only applies to the v4 API definition.

WiredUp URL on BulkIdeas API

The BulkIdeas API now includes a WiredUp URL to the Idea record within the API. This allows the user to select the URL within the idea record and they will be navigated to the Idea within the WiredUp system.