Crowdsourcing Ideas API

People are the most important part of any organization, and it is their ideas that fuel innovation and progress. EASE taps into the creativity and experience of the people at your company with a crowdsourcing feature that lets App Catalog users submit ideas about new apps and other improvements to benefit the organization.

Use the Crowdsourcing Ideas API to:

  • Post a new idea
  • List ideas already stored in the database
  • Delete an idea

Note

This functionality is available in EASE via this API only; there is no ideas feature delivered as part of the EASE Portal or standard App Catalog.

Resources

POST /v1/organizations/ideas/

Add Idea

Authenticate as a valid EASE user.

Inserts a new idea into the EASE database. An idea consists of a title and comment (the description of the idea).

URLs

Environment URL
North America https://na01ws.apperian.com/v1/organizations/ideas/
Europe https://eu01ws.apperian.eu/v1/organizations/ideas/

URL Parameters

None

Header Parameter

X-TOKEN
(Required) Unique identifier assigned by EASE to the device.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: application/json
X-UDID
(Required) Session token returned by POST /users/authenticate.

Data Parameters

title
(Required) The title of the idea.
comment
(Required) The description of the idea.

Example Request

curl -X GET "https://na01ws.apperian.com/v1/organizations/ideas/" --header "Content-Type: application/json" --header "X-TOKEN: yCczCnsNSJyW_3JyS6YwAQ" --header "X-UDID: 90b0e24db7f650bbec684b60c6da855e4c98b28b" --data '{"title":"Training", "comment":"We need an app that provides access to all Example Company's online training courses."}'

Example Response

When the idea is added successfully, EASE returns a unique ID for the idea (the idea_psk).

{
     "idea": 90
}
GET /v1/organizations/ideas/

List Ideas

Requires user context. Authenticate as a valid EASE user.

Returns a list of the ideas stored in the EASE database for the authenticated user’s organization.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/organizations/ideas/
Europe https://eu01ws.apperian.eu/v1/organizations/ideas/

URL Parameters

None

Header Parameter

X-UDID
(Required) Unique identifier assigned by EASE to the device.
X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET "https://na01ws.apperian.com/v1/organizations/ideas/" --header "Content-Type: application/json"
     --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

"ideas": [
     {
       "comment": "How about an app that shows today's lunch menu and lets us preorder our lunch to save time.",
       "psk": 1,
       "title": "Cafeteria App",
       "created": "2013-10-18T19:13:43.758736+00:00",
       "user": {
         "psk": 2,
         "first_name": "Michael",
         "last_name": "Harrison"
       },
       "device": {
         "psk": 5
       }
     },
     ...
     {
       "comment": "I would like an app that reroutes my office phone to my mobile phone with just one click.",
       "psk": 89,
       "title": "Reroute my office phone",
       "created": "2013-10-21T10:16:22.295130+00:00",
       "user": {
         "psk": 2,
         "first_name": "Jose",
         "last_name": "Diaz"
       },
       "device": {
         "psk": 5
       }
     }
]
DELETE /v1/organizations/ideas/(int: idea_psk)/

Delete Idea

Requires administrator privileges. Authenticate as an EASE administrator.

Deletes an idea from the EASE database. Once an idea is deleted, it is no longer listed on the Ideas page in the EASE Portal or in the App Catalog.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/organizations/ideas/<int:idea_psk>/
Europe https://eu01ws.apperian.eu/v1/organizations/ideas/<int:idea_psk>/

URL Parameters

idea_psk
(Required) Unique ID assigned by EASE to the idea when it was added. DATA TYPE: integer

Header Parameters

X-UDID
(Required) Unique identifier assigned by EASE to the device.
X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X DELETE "https://na01ws.apperian.com/v1/organizations/ideas/567/" --header "Content-Type: application/json" --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

This is an example response when the idea is successfully deleted.

{
     "deleted": true
}