Overview
Minyaa Times Edition comes with some REST APIs which allows to access to manage/request LogWork.
Worklog Type Management
Worklog Type Management provides 2 REST APIs, used in order to retrieve Worklog Types in Gadget.
/rest/minyaaTime/1.0/worklogTypes/all
| Description | Retrieve all Worklog Types |
|---|
| Method | POST |
|---|
| Content-Type | application/json |
|---|
| Parameters | None |
|---|
| HTTP 200 Return | An array of JSON Worklog Types is returned :
01.{
02. id: "10001",
03. name: "Analysis",
04. nameTranslation: "Analysis",
05. description: "Analysis",
06. sequence: 1,
07. iconurl: "/download/resources/jira.plugin.minyaa.time:Actions/icons/worklogtypes/wlAnalysis_16.png",
08. statusColor: "#3300ff"
09.}
| Properties | Values | Descriptions |
|---|
| id | int | Worklog Type Id |
| name | string | Worklog Type Name |
| nameTranslation | string | Worklog Type Name internationalized |
| description | string | Worklog Type Description |
| sequence | int | Sequence Order |
| iconurl | string | URL of the associated icon. |
| statusColor | string | RGB Code Color |
|
|---|
/rest/minyaaTime/1.0/worklogTypes/allowed/{issueId}
| Description | Retrieve only allowed Worklog Types (depending on Workflow Settings) |
|---|
| Method | POST |
|---|
| Content-Type | application/json |
|---|
| Parameters |
| Parameter | From | Values | Descriptions |
|---|
| issueId | PathParam | int | Id. of the issue |
|
|---|
| HTTP 200 Return | An array of JSON Worklog Types is returned :
See previous API ...
|
|---|
LogWork Management
/rest/minyaaTime/1.0/worklog/create/{issueId}
| Description | Create a Worklog for an Issue in respect of different Custom Minyaa Time Permissions (Delegate Log Work, Wokrlog Closure Period, Required/Allowed Worklgo Type) |
|---|
| Method | POST |
|---|
| Content-Type | application/json |
|---|
| Parameters |
| Parameter | From | Values | Descriptions |
|---|
| issueId | PathParam | int | Id. of the issue |
| LogWork | POSTParam | bean |
| Properties | Ordinality (Default) | Values | Descriptions |
|---|
| timeSpent | Mandatory | string | Spent time using the JIRA Format 9w 9d 9h 9m |
| adjustEstimate | Optional (auto) | string | Define how is set the Remaining Estimate ...[auto|leave|new|manual] |
| timeRemaining | Optional | string | The Remaing Estimate to use in case of [new] |
| startDate | Optional (Now) | datetime | Date of Log Work occurrence using the format [yyyy-MM-dd'T'HH:mm:ss.SSSZ]. |
| authorName | Optional (current User) | string | Author of Worklog. |
| worklogTypeId | Optional | string | Id of the Worklog Type |
| comment | Optional | string | Associated comment |
| commentLevel | Optional | string | How is restricted the Comment visibility [group:groupName] or [role:projectRoleId] |
| Sample | Description |
|---|
1.{
2. "timeSpent":"15m",
3. "worklogTypeId":"10000",
4. "comment":"Hello"
5.}
| Create a Log Work for Now qualified with Worklog Type identified by 10000 |
01.{
02. "timeSpent":"15m",
03. "adjustEstimate":"new",
04. "timeRemaining":"1d",
05. "startDate":"2014-09-10T15:00:00.000+0200",
06. "authorName":"dev1",
07. "worklogTypeId":"10000",
08. "comment":"Hello",
09. "commentLevel":"group:jira-developers"
10.}
| Create a Log Work with :
- a specified Date
- another Log Work author (Edit Worklogs for Team Members permission required)
- a comment restricted to jira-developers group
- a Remaining Estimate set to 1d
|
|
|
|---|
| HTTP 200 Return | On Worklog creation a JSON bean is returned :
02."worklogId":10623,
03."timeLogged":900,
04."authorName":"dev1",
05."startDate":"2014-09-10T15:00:00.000+0200",
06."created":"2014-09-11T10:00:37.902+0200",
07."updated":"2014-09-11T10:00:37.902+0200",
08."updateAuthorName":"dev1",
09."worklogTypeId":"10000",
10."comment":"Hello",
11."commentLevel":"jira-developers"}
02."worklogId":10623,
03."timeLogged":900,
04."authorName":"admin",
05."startDate":"2014-09-10T15:00:00.000+0200",
06."created":"2014-09-11T10:00:37.902+0200",
07."updated":"2014-09-11T10:00:37.902+0200",
08."updateAuthorName":"dev1",
09."worklogTypeId":"10000",
10."comment":"Hello",
11."projectRoleId":10000}
| Properties | Values | Descriptions |
|---|
| self | string | URL to retrieve the details of this Worklog |
| worklogId | int | Id. of the Worklog |
| timeLogged | xxx | Logged time expressed in seconds |
| authorName | string | Log Work author |
| startDate | datetime | Date of Log Work |
| created | datetime | Creation Date of Log Work |
| updated | datetime | Update Date of Log Work |
| updateAuthorName | string | Log Work updater |
| worklogTypeId | string | Id. of Worklog Type |
| comment | string | Associated Comment |
| commentLevel | string | Group Name use to resctrict access to the Worklog (exclusive with projectRoleId) |
| projectRoleId | int | Project Role Id. use to resctrict access to the Worklog (exclusive with commentLevel) |
|
|---|
| HTTP 404 Return | In case of Validation error, the Error Collection is returned.
1.[{"errorMessages":["Any Error Message"],"errors":{}}]
|
|---|
/rest/minyaaTime/1.0/worklog/validate
To be described
/rest/minyaaTime/1.0/worklog/generate
To be described
/rest/minyaaTime/1.0/worklog/sortByAttributes/values
To be described
Timesheet Management
/rest/minyaaTimesheet/1.0/timesheet/caller/validate
To be described
/rest/minyaaTimesheet/1.0/timesheet/caller/generate
To be described
/rest/minyaaTimesheet/1.0/timesheet/{timesheetCallerRule}
To be described
/rest/minyaaTimesheet/1.0/timesheet/{timesheetId}/timesheet/{timesheetCallerRule}
To be described
/rest/minyaaTimesheet/1.0/timesheet/{timesheetCallerRule}/generate
To be described
/rest/minyaaTimesheet/1.0/timesheet/{timesheetId}/action/{actionId}
To be described
/rest/minyaaTimesheet/1.0/timesheet/{timesheetId}/Actions
To be described
