Bontq API was created to allow a much easier access for third-party developers to the product's core functionality.
In case something is unclear and you wish to receive more information - feel free to contact us: support@bontq.com
|
API Requests
To send API requests you should use the URL of the following structure: "http://accountname.bontq.com/service/api/functionname".
For example, if your domain is "zendinc.bontq.com" and you wish to get the list of your users you should send your request with parameters to "http://zendinc.bontq.com/service/api/getusers".
* Please note that before sending any requests you should sign in.
|
C# and PHP Examples
We made two examples for your convenience. To view them just download the files and open them in your local text/code editor.
C#: example.cs
PHP: example.php
|
|
Name
|
Type
|
Minval(char)
|
Maxval(char)
|
Allowed Values
|
Default
|
Return Type
|
Description
|
|
signin
|
post
|
|
|
|
|
string
|
You should sign in first to make API requests.
Returns 'success' or 'failure'.
|
|
email
|
string
|
0
|
255
|
|
|
|
|
|
pass
|
string
|
0
|
255
|
|
|
|
|
|
signout
|
get/post
|
|
|
|
|
string
|
Optional method - can be used to kill the current session started by "signin" method.
Returns 'success' or 'failure'.
|
|
getсompanies
|
get/post
|
|
|
|
|
array
|
Array of companies with detailed info is returned.
If a valid companyID is passed - info only for this particular company is returned.
|
|
companyID
|
int
|
0
|
11
|
|
|
|
|
|
getprojects
|
get/post
|
|
|
|
|
array
|
Like in getcompanies method, here is returned an array of companies that also includes their projects.
If a valid companyID is passed - info only for this particular company and it's projects are returned.
|
|
companyID
|
int
|
0
|
11
|
|
|
|
|
|
getusers
|
get/post
|
|
|
|
|
|
|
|
orderdir
|
string
|
|
|
asc,desc
|
asc
|
|
|
|
orderby
|
string
|
|
|
email, position, status, last_activity, last_login, created, name
|
name
|
|
|
|
projectID
|
int
|
0
|
11
|
|
|
|
|
|
getpriorities
|
get/post
|
|
|
|
|
array
|
A list of priorities is returned
|
|
getstatuses
|
get/post
|
|
|
|
|
array
|
A list of items statuses with resolutions is returned.
|
|
getlabels
|
get/post
|
|
|
|
|
array
|
Get general labels or labels for particular project
|
|
projectID
|
int
|
0
|
11
|
|
|
|
Can be obtained using getprojects method. If projectID is valid and user have access permissions to it - the list of this project's labels is returned. If projectID is not passed, is null or user has no permission to access it - a list of general labels is returned.
|
|
getitems
|
get/post
|
|
|
|
|
array
|
|
|
companyID
|
int
|
0
|
11
|
|
|
|
|
|
projects
|
array of int
|
0
|
11
|
|
|
|
|
|
orderdir
|
string
|
|
|
asc,desc
|
desc
|
|
|
|
orderby
|
string
|
|
|
name, id, date_opened, status, resolution, label, opened_by, assigned_to, resolved_by, closed_by, date_modified, project, date_end, item_type, time_estimate
|
date_opened
|
|
|
|
perPage
|
int
|
0
|
11
|
|
16
|
|
|
|
page
|
int
|
0
|
11
|
|
1
|
|
|
|
status
|
string
|
|
|
open, closed
|
1
|
|
Is applicable to bug, task, f_request, test_case
|
|
filter_items
|
array of string
|
|
|
bug, task, f_request, test_case, notice, wiki
|
|
|
|
|
resolutions
|
array of int
|
0
|
11
|
|
|
|
Is applicable to bug only
|
|
labels
|
array of int
|
0
|
11
|
|
|
|
Is applicable to bug, task, f_request, test_case
|
|
priorities
|
array of int
|
0
|
11
|
|
|
|
Is applicable to bug, task, f_request, test_case
|
|
env
|
string
|
|
|
|
|
|
Environment filter is appplicable to bug only
|
|
users
|
array of int
|
0
|
11
|
|
|
|
|
|
users
|
array of int
|
0
|
11
|
|
|
|
|
|
return_assigned_users
|
string
|
0
|
1
|
Y, N
|
N
|
|
|
|
return_desc_env
|
string
|
0
|
1
|
Y, N
|
N
|
|
|
|
return_files
|
string
|
0
|
1
|
Y, N
|
N
|
|
|
|
return_comments
|
string
|
0
|
1
|
Y, N
|
N
|
|
|
|
return_notify_users
|
string
|
0
|
1
|
Y, N
|
N
|
|
|
|
return_assigned_users
|
string
|
0
|
1
|
Y, N
|
N
|
|
|
|
additem
|
get/post
|
|
|
|
|
array
|
This method allows to add a bug, task, f_request, test_case, wiki or a notice
|
|
name
|
string
|
|
|
|
|
|
* This field is obligatory
|
|
description
|
string
|
|
|
|
|
|
|
|
status
|
int
|
0
|
11
|
1 = Open, 2 = Closed
|
1
|
|
Is applicable to bug, task, f_request, test_case
|
|
resolution
|
int
|
0
|
11
|
|
5 for Open, 8 for Closed
|
|
Is applicable to bug only. If a resolution in not applicable to selected status, it is replaced with the default one (Assigned for Open and Fixed for Closed).
|
|
projectID
|
int
|
0
|
11
|
|
|
|
Is applicable to bug, task, f_request, test_case, wiki
|
|
priority
|
int
|
0
|
11
|
|
|
|
Is applicable to bug, task, f_request, test_case
|
|
priority
|
int
|
0
|
11
|
|
|
|
Is applicable to bug, task, f_request, test_case
|
|
label
|
int
|
0
|
11
|
|
|
|
|
|
item_start
|
string
|
|
|
|
|
|
Is applicable to bug, task, f_request, test_case
|
|
item_finish
|
string
|
|
|
|
|
|
Is applicable to bug, task, f_request, test_case
|
|
itype
|
int
|
1
|
1
|
1 = bug, 2 = notice, 3 = f_request, 4 = task, 5 = test_case, 6 = wiki
|
|
|
* This field is obligatory
|
|
environment
|
|
|
|
|
|
|
Is applicable to bug only.
|
|
notify
|
string
|
0
|
1
|
Y, N
|
N
|
|
Is applicable to bug, task, f_request, test_case, wiki
|
|
notify_users
|
array of int
|
0
|
11
|
|
|
|
Is applicable to bug, task, f_request, test_case, wiki
|
|
assign_users
|
array of int
|
0
|
11
|
|
|
|
Is applicable to bug, task, f_request, test_case, wiki
|
|
case_result
|
string
|
|
|
|
|
|
Is applicable to test_case only
|
|
case_procedure
|
string
|
|
|
|
|
|
Is applicable to test_case only
|
|
case_actual_result
|
int
|
0
|
1
|
0 for Failed, 1 for Passed
|
|
|
Is applicable to test_case only
|
|
time_estimation_h
|
int
|
0
|
11
|
|
|
|
Is applicable to test_case only
|
|
time_estimation_m
|
int
|
0
|
11
|
|
|
|
Is applicable to test_case only
|
|
deleteitem
|
get/post
|
|
|
|
|
array
|
This method allows to add a bug, task, f_request, test_case, wiki or a notice
|
|
itemID
|
int
|
0
|
11
|
|
|
|
|
|
getfile
|
get/post
|
|
|
|
|
binary or string
|
This method allows to obtain a particular file. In case you do not have permission to view the file or the file does not exist anymore you will get a "file_was_deleted" error.
|
|
