defaultheader

LIST tag

Get data on a list of tag objects. Objects are ordered by tag name descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters Detail
member_id
optional
Filter return by ID of idea submitter
Sample value: "11111111-1111-1111-1111-111111111111"
idea_id
optional
Filter return by ID of a idea
Sample value: "11111111-1111-1111-1111-111111111111"
page_size
optional
Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100
Sample value: 50
page
optional
Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count}
Sample value: 5
order
optional
A SQL style string that specifies the order the records should return in
Sample value: "date_created ASC, screen_name DESC"
Accepted attributes: "tag_name", "tag_count"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/tag

Access Permission

Access to data varies base on system setting and requester roles. See Oauth 2.0 for details on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Requster Role: Some response attributes are accessible base on the requester's role.

  • Hidden idea: Tags will return for Admin only

Errors

  • Invalid object ID or you don't have access to this object

Example Request

  • Method: GET
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/tag?page_size=2&page=4

    {
        "tag_list": [
            {
                "id": "F06589C0-6E65-4722-A911-E966E09828C8",
                "name": "tag2",
                "tagCount": 1
            },
            {
                "id": "113BAF9C-45BE-4D8E-B9E3-DCFD46D029E6",
                "name": "tag1",
                "tagCount": 1
            }
        ],
        "stats": {
            "total": "50",
            "page_count": 25,
            "current_page": 4
        }
    }
    

CREATE tag

Create a tag object.

Requester must have access to the Campaign in order to create a tag in it.

Parameters

Parameters Detail
idea_id
required
This is the id of the idea.
Sample value: "11111111-1111-1111-1111-111111111111"
tag
required
This is the tag name
Sample value: "TagName"

Resource Information

Authentication: Required. See Oauth 2.0 for details on authentication.

HTTP Methods: POST

Request URL Format: https://{api_domain}/api3/tag

Access Permission

Requester must have access to the Campaign in order to create an tag in it. See Oauth 2.0 for details on authentication.

Errors

  • You don't have permission for this campaign
  • Invalid {parameter} received
  • Missing required parameter

Example Request

  • Method: POST
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/tag
  • Form data:

    • idea_id=A0A1A1C0-3F00-46E3-903D-EFCF80D7C8BE
    • tag=test
    {
        "idea": {
            "id": "A0A1A1C0-3F00-46E3-903D-EFCF80D7C8BE",
            "date_created": "2013-03-21 19:10:14.277",
            "date_modified": "2013-05-28 14:30:04.670",
            "title": "Test Idea",
            "description": "Description of test idea",
            "visible": true,
            "anonymous": false,
            "idea_code": "D2649",
            "campaign": {
                "id": "E969BC71-BD70-4D6D-99FD-F28079DA7B8E",
                "name": "Test Campaign",
                "description": "Test webstrom created",
                "date_created": "2013-03-07 17:10:13.627",
                "date_modified": "2013-03-12 15:05:25.517",
            },
            "tags": [
                {
                "id": "46C86CE2-CAB9-469E-8A47-3FA72AE8EADF",
                "name": "test",
                "tagCount": 1
                }
    
            ]
    
        }
    }
    

DELETE tag

Delete a tag object of an idea. Requester must be an Admin.

Parameters

Parameters Detail
idea_id
required
This is the id of the idea.
Sample value: "11111111-1111-1111-1111-111111111111"
tag
required
This is the tag name
Sample value: "TagName"
format
optional
Specifies returned data format
Accepted value: "json", "xml"

Resource Information

  • Authentication: Required
  • HTTP Methods: DELETE
  • Request URL Format: https://{api_domain}/api3/tag/{id}

Access Permission

Requester must be an Admin.

Errors

  • Invalid GUID received
  • Admin permission required.

Example Request

  • Method: DELETE
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
  • URL: https://example.brightidea.com/api3/tag/4D7C68A6-8408-4340-8EE1-EF6404F5F1CB
  • Form data:

    • idea_id=A0A1A1C0-3F00-46E3-903D-EFCF80D7C8BE
    • tag=test
    {
        "message": "success",
        "code": 200
    }
    

FAQ

Question: LIST tag only return 100 objects maximum per request. How do I retrieve more results.

Answer: LIST tag response is automatically paginated. You can specify which page of the result a request should return. For example, if you requested for 100 tag objects in the initial request, pass "page_size=100&page=2" to get the next 100. page_count is returned with every LIST request so your application can figure out when it hits the end.