How do I use the API to get a copy of all ideas in the system ?

Easily, if you have an administrator account.

First, log into your instance - make sure you are authenticated

Then, put this url in:

http://idealink.io/api/[tenant]/system/help

where [tenant] is your tenant ID - this can be found in your instance URL:

https://idealink.io/[your tenant ID is here!]-default/

Once you enter the api/[tenant] URL in your browser, hit ENTER - you will see something like the following:

{  "Audit": [    {      "ActionName": "Get",      "ControllerName": "Audit",      "Documentation": "Get a queryable list of resources.",      "HttpMethod": "Get",      "Arguments": [],      "RelativePath": "{tenant}/latest/Audit",      "ReturnType": {        "Name": "IEnumerable<Audit>",        "QualifiedName": "System.Collections.Generic.IEnumerable`1[[Idealink.Api.Contracts.Core.Auditing.Audit, Idealink.Api.Contracts, Version=8.0.4.11, Culture=neutral, PublicKeyToken=null]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"      }    },

It will go on and be quite long, this is the API's documentation. Since you want to get a list of all ideas you can search for: "Ideas" (with the quotes), you will see the following:

"Ideas": [    {      "ActionName": "Get",      "ControllerName": "Ideas",      "Documentation": "Get a queryable list of resources.",      "HttpMethod": "Get",      "Arguments": [],      "RelativePath": "{tenant}/latest/Ideas",      "ReturnType": {        "Name": "IEnumerable<Idea>",        "QualifiedName": "System.Collections.Generic.IEnumerable`1[[Idealink.Api.Contracts.Core.Idea, Idealink.Api.Contracts, Version=8.0.4.11, Culture=neutral, PublicKeyToken=null]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"      }    }

In a technical REST/API sort of way, this is basically telling you that in order to GET IDEAS you need to use the url in the RelativePath, this means:

http://idealink.io/api/[tenant id]/latest/Ideas

This will bring up a list of all ideas with peripheral data, you can explore the API documentation in your browser to extract any other type of information and simply save it to a text file. The format of the output is JSON.

Feedback and Knowledge Base