defaultheader

GET blogComment

Get data of one blogComment object.

Parameters

Parameters Detail
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/blogComment

Access Permission

Access to data varies based on system settings 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.

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/blogComment/68B5914F-744F-47B4-A5F2-F9E818AE3E44

     {
    blogComment: {
        id: "68B5914F-744F-47B4-A5F2-F9E818AE3E44"
        date_created: "2013-12-15 13:36:28.370"
        text: "Example Blog Comment"
        reference_id: "7C627843-97CE-40A9-85DF-410A0BE05678"
}
}




LIST blogComment

Get data on a list of blogComment objects. Objects are order by created date 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
text
optional		 Filter return by blogComment text
Sample value: "This is a great comment"
date_created
optional		 Filter return by blogComment created date. Response contains all comments created within the 24 hours of the specified date
Sample value: "12/06/2009"
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, idea_code DESC"
Accepted attributes: "date_created"
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/blogComment

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.

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/blogComment?page_size=2&page=4&order=date_created

        {
blogComment_list: [2]
    0:  {
        id: "98CD1A6F-CE4B-4C3E-9EFB-F504B1361492"
        date_created: "2013-12-27 13:31:58.337"
        text: "buddi blog comment"
        reference_id: "7C627843-97CE-40A9-85DF-410A0BE05678"
    }
    1:  {
        id: "68B5914F-744F-47B4-A5F2-F9E818AE3E44"
        date_created: "2013-12-27 13:36:28.370"
        text: "create new blog comment"
        reference_id: "7C627843-97CE-40A9-85DF-410A0BE05678"
    }

stats: {
    total: 8
    page_count: 4
    current_page: 4
}
}




CREATE blogComment

Create a blogComment object.

Parameters

Parameters Detail
text
required		 This is the title of the blogComment. Minimum 1 character, maximum 100 characters. String will be truncated if length exceeds maximum
Sample value: "Test comment text"
blog_id
required		 This is the ID of the blog
Sample value: "11111111-1111-1111-1111-111111111111"

Resource Information

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

HTTP Methods: POST

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

Errors

  • Text cannot be blank
  • Missing required parameter

Example Request

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

  • Form data:

    • comment=This is a test comment
    • blog_id=94131ECC-A410-4A69-9EF1-6D827574438B
    {
    Comment: {
        id: "255D4A44-7F14-4B42-BC09-20CE26457EAB"
        date_created: "2014-01-13 17:48:49.350"
        text: "This is a test comment"
        reference_id: "94131ECC-A410-4A69-9EF1-6D827574438B"
    }
}




DELETE blogComment

Delete a blogComment object. Requester must be an Admin.

Parameters

Parameters Detail
format
optional		 Specifies returned data format
Accepted value: "json", "xml"

Resource Information

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

Access Permission

Requester must be an Admin.

Errors

  • An error occurred while processing your request

Example Request

  • Method: DELETE
  • Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

  • URL: https://example.brightidea.com/api3/blogcomment/255D4A44-7F14-4B42-BC09-20CE26457EAB

    {
    "message": "success",
    "code": 200
}




FAQ

List blogComment: LIST blog comment can also be retrieved with https://{api_domain}/_blogComment/list.

Authentication: See Access Permission

HTTP Methods: GET

Request URL Format: https://{api_domain}/_blogComment/list