At this moment, ictime does not offer any of it's functionality or data via an API. It is planned to offer selected functionality and data as part of a separate add-on until end of 2014.
ictime Custom Log Work Field & JIRA API
As the custom field provided by ictime to log work as part of workflow transition screens (Custom Log Work Field) is logically a part of JIRA, you can use the JIRA REST API (https://developer.atlassian.com/display/JIRADEV/JIRA+REST+APIs) to work with this field (e.g. to log work as kind of API-driven, automated workflow transitions).
This option is available since ictime 4.0.4. Previous versions do not support using the JIRA REST API.
Please have a look at the following example (use the JIRA REST API browser to test: https://developer.atlassian.com/display/DOCS/Using+the+REST+API+Browser):
{ "update": { "comment": [ { "add": { "body": "." } } ] }, "fields": { "customfield_10100":"nocharge==on||noChargeInfo==why this should not be charged||timeSpentCorrected==5h||adjustEstimate==new||newEstimate==5w||activity==3||startDate==Sep 29, 2014 9:34 AM||startTime==5:05 PM||endTime==5:07 PM||comment==my worklog description||issueKey==ABCD-239||logWorkOption==summary||timeLogged==6h||", "assignee": { "name": "bob" }, "resolution": { "name": "Fixed" } }, "transition": { "id": "5" } }
Custom field ID for the ictime "Log work" field will be different for your JIRA installation, as well as time & date formats might be.
Parameter | Description | Remarks |
---|---|---|
"comment" | JIRA comment | Mandatory. Please note that JIRA usually expects the "comment" field populated. If you fill in something here, it will be displayed in the comment section of the issue. The example above just fills in a "." to avoid that the work log description appears in the comments. |
"activity" | ID of the activity type in ictime | Optional, only if you use the feature. |
"timeLogged" | Result (time logged). Expects the format defined in JIRA. | Required if logWorkOption is "summary" |
"startTime" | Start time for your work log. Expects the format defined in JIRA. | Required if logWorkOption is "fromTo" |
"endTime" | End time for your work log. Expects the format defined in JIRA. | Required if logWorkOption is "fromTo" |
"startDate" | Date. Expects the format defined in JIRA. | Mandatory. |
"logWorkOption" |
| Mandatory. |
"nocharge" | "on" if this entry should not be charged | Optional, only if you use the feature. |
"noChargeInfo" | Optional information if a work log should not be charged ("nocharge" is "on"). | Optional, only if you use the feature. |
"timeSpentCorrected" | The corrected amount of time (to be charged instead of the time resulting from "timeLogged" (or "startTime" and "endTime"). The other values are still required. | Optional, only if you use the feature. |
"adjustEstimate" | JIRA options to handle an existing extimate.
| Default is "auto". |
"newEstimate" | If "adjustEstimate" is "new". Expects the format defined in JIRA. | |
"adjustmentAmount" | If "adjustEstimate" is "manual". Expects the format defined in JIRA. | |
"issueKey" | Issue key. | Mandatory. |
JIRA and ictime error handling is available, you should get meaningful error responses.