Important note Retirement of icTime and Retirement of biz on December 29th, 2023
Prerequisites
- Smadoa GmbH
Authentication
To use the REST-API, you (the "API user") need to be authenticated.
curl -D- -u user:password -X GET -H "Content-Type: application/json" https://example.com/myjira/rest/icbiz/1.0/wla/activityTypeAssigned?activityTypeId=3
(modify URL according to your installation path)
Please find all details in the respective JIRA documentation https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Basic+Authentication
If you are not using a separate "API user" that never logs in into JIRA, but a user who logs in into JIRA, keep in mind that it might happen that during manual login, you enter a wrong password a couple of times, which - if JIRA is configured this way - will lead to a situation where the API user does not work any longer because JIRA expects the user entering a captcha text!
Check if icbiz Properly Works
You can check if icbiz works correctly by calling the following WADL (see http://de.wikipedia.org/wiki/Web_Application_Description_Language) link:
https://example.com/myjira/rest/icbiz/1.0/application.wadl?_=142081795312
(modify URL according to your installation path)
The lnk should return the icbiz documentation.
If you use the (patched) JIRA REST API Browser (see JIRA REST API Browser), you should see the respective services starting with icbiz/. If this is not the case, your JIRA REST API Browser either does not work correctly/has not been patched or icbiz is not running correctly.
Example Request and Response
Request
curl -D- -u user:password -X GET -H "Content-Type: application/json" https://example.com/myjira/rest/icbiz/1.0/activitytype/list?projectKey=ABC
Response
{
"responseType": "OK",
"fieldErrors": [],
"errMsgs": [
{
"errorMsg": ""
}
],
"data": {
"responseType": "OK",
"fieldErrors": [],
"errMsgs": [],
"pagination": {
"startIndex": 0,
"maxResults": 2,
"totalResults": 2,
"clazz": "de.iconcept.icbiz.api.response.Pagination"
},
"dataList": [
{
"isDefault": false,
"clazz": "de.iconcept.icbiz.api.entities.ActivityTypeRest",
"description": "",
"name": "Documentation",
"id": 7
},
{
"isDefault": false,
"clazz": "de.iconcept.icbiz.api.entities.ActivityTypeRest",
"description": "",
"name": "Support",
"id": 8
}
],
"clazz": "de.iconcept.icbiz.api.response.ResultList"
},
"clazz": "de.iconcept.icbiz.api.response.ResponseIct"
}
Permissions
Depending on which operations you want to use via the REST services, your API user needs respective permissions in JIRA and ictime. The following permissions are required for icbiz (for all projects) if all features are used:
| Permissions | System | Description |
|---|---|---|
| Global "JIRA Administrators" permission. | JIRA | Required to create/copy projects. |
| Administer Projects Ability to administer a project in JIRA. | JIRA | Required to create/copy projects. (?) |
| Browse Projects Ability to browse projects and the issues within them. | JIRA | Required to create/copy projects. |
| Create Issues Ability to create issues. | JIRA | Required to create/copy projects, if issues are copied. |
| Create Attachments Users with this permission may create attachments. | JIRA | Required to create/copy projects, if issues have attachments. |
| Delete Own Attachments Users with this permission may delete own attachments. | JIRA | |
| Activity Types Permission to configure activity types | ictime | To create or update activity types. |
| Work Log Attributes Permission to manage Work Log Attributes | ictime | To assign WLA to activity types or projects. |
| Project Configuration Permission to configure projects | ictime | To assign/remove activity tyoes to/from projects. |
| Reporting Permission to generate reports | ictime | To run reports. |
| Accounting Permission to charge work logs and to access accounting, including the permission to create, edit and delete work logs for projects in status inactive; also requires reporting permission | ictime | To charge work logs of a report. |
Additional JIRA permissions are required if you are working with the JIRA REST API for additional operations on issues.