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

DescriptionRetrieve all Worklog Types
MethodPOST
Content-Typeapplication/json
ParametersNone
HTTP 200 ReturnAn array of JSON Worklog Types is returned :

{
	id: "10001",
	name: "Analysis",
	nameTranslation: "Analysis",
	description: "Analysis",
	sequence: 1,
	iconurl: "/download/resources/jira.plugin.minyaa.time:Actions/icons/worklogtypes/wlAnalysis_16.png",
	statusColor: "#3300ff"
}


PropertiesValuesDescriptions
idintWorklog Type Id
namestringWorklog Type Name
nameTranslationstringWorklog Type Name internationalized
descriptionstringWorklog Type Description
sequenceintSequence Order
iconurlstringURL of the associated icon.
statusColorstringRGB Code Color

/rest/minyaaTime/1.0/worklogTypes/allowed/{issueId}

DescriptionRetrieve only allowed Worklog Types (depending on Workflow Settings)
MethodPOST
Content-Typeapplication/json
Parameters
ParameterFromValuesDescriptions
issueIdPathParamintId. of the issue
HTTP 200 ReturnAn array of JSON Worklog Types is returned :

See previous API ...

LogWork Management

/rest/minyaaTime/1.0/worklog/create/{issueId}

DescriptionCreate a Worklog for an Issue in respect of different Custom Minyaa Time Permissions (Delegate Log Work, Wokrlog Closure Period, Required/Allowed Worklgo Type)
MethodPOST
Content-Typeapplication/json
Parameters
ParameterFromValuesDescriptions
issueIdPathParamintId. of the issue
LogWorkPOSTParambean
PropertiesOrdinality (Default)ValuesDescriptions
timeSpentMandatorystringSpent time using the JIRA Format 9w 9d 9h 9m
adjustEstimateOptional (auto)stringDefine how is set the Remaining Estimate ...[auto|leave|new|manual]
timeRemainingOptionalstringThe Remaing Estimate to use in case of [new]
startDateOptional (Now)datetimeDate of Log Work occurrence using the format [yyyy-MM-dd'T'HH:mm:ss.SSSZ].
authorNameOptional (current User)stringAuthor of Worklog.
worklogTypeIdOptionalstringId of the Worklog Type
commentOptionalstringAssociated comment
commentLevelOptionalstringHow is restricted the Comment visibility [group:groupName] or [role:projectRoleId]
SampleDescription
{
	"timeSpent":"15m",
	"worklogTypeId":"10000",
	"comment":"Hello"
}


Create a Log Work for Now qualified with Worklog Type identified by 10000 
{
	"timeSpent":"15m",
	"adjustEstimate":"new",
	"timeRemaining":"1d",
	"startDate":"2014-09-10T15:00:00.000+0200",
	"authorName":"dev1",
	"worklogTypeId":"10000",
	"comment":"Hello",
	"commentLevel":"group:jira-developers"
}


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 ReturnOn Worklog creation a JSON bean is returned :

{"self":"http://localhost:8080/rest/minyaaTime/1.0/worklog/10623",
"worklogId":10623,
"timeLogged":900,
"authorName":"dev1",
"startDate":"2014-09-10T15:00:00.000+0200",
"created":"2014-09-11T10:00:37.902+0200",
"updated":"2014-09-11T10:00:37.902+0200",
"updateAuthorName":"dev1",
"worklogTypeId":"10000",
"comment":"Hello",
"commentLevel":"jira-developers"}



{"self":"http://localhost:8080/rest/minyaaTime/1.0/worklog/10623",
"worklogId":10623,
"timeLogged":900,
"authorName":"admin",
"startDate":"2014-09-10T15:00:00.000+0200",
"created":"2014-09-11T10:00:37.902+0200",
"updated":"2014-09-11T10:00:37.902+0200",
"updateAuthorName":"dev1",
"worklogTypeId":"10000",
"comment":"Hello",
"projectRoleId":10000}


PropertiesValuesDescriptions
selfstringURL to retrieve the details of this Worklog
worklogIdintId. of the Worklog
timeLoggedxxxLogged time expressed in seconds
authorNamestringLog Work author
startDatedatetimeDate of Log Work
createddatetimeCreation Date of Log Work
updateddatetimeUpdate Date of Log Work
updateAuthorNamestringLog Work updater
worklogTypeIdstringId. of Worklog Type
commentstringAssociated Comment
commentLevelstringGroup Name use to resctrict access to the Worklog (exclusive with projectRoleId)
projectRoleIdintProject Role Id. use to resctrict access to the Worklog (exclusive with commentLevel)
HTTP 404 ReturnIn case of Validation error, the Error Collection is returned.

[{"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