JiBrok "Time in status" Jira rest api (4.0.0 BETA)

Download OpenAPI specification:Download

Site JiBrok.com. Description of publicly rest api for Plugin Time in status. BASE REST URL - http://{baseUrl}/rest/jibrok/timeinstatus/1.0

util

System service

reset all cache in plugin

Responses

200

OK

get /cacheUtils/resetAllCache

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/cacheUtils/resetAllCache

stopwatch

Stopwatch management service

use action "start" to stopwatch custom field

/stopwatchManager/start?issueKey=TEST-1&customFieldId=10000

query Parameters
issueKey
string
issueId
number
customFieldId
number

Responses

200

OK

get /stopwatchManager/start

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/stopwatchManager/start

use action "pause" to stopwatch custom field

/stopwatchManager/pause?issueKey=TEST-1&customFieldId=10000

query Parameters
issueKey
string
issueId
number
customFieldId
number

Responses

200

OK

get /stopwatchManager/pause

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/stopwatchManager/pause

use action "stop" to stopwatch custom field

/stopwatchManager/stop?issueKey=TEST-1&customFieldId=10000

query Parameters
issueKey
string
issueId
number
customFieldId
number

Responses

200

OK

get /stopwatchManager/stop

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/stopwatchManager/stop

use action "restart" to stopwatch custom field

/stopwatchManager/restart?issueKey=TEST-1&customFieldId=10000

query Parameters
issueKey
string
issueId
number
customFieldId
number

Responses

200

OK

get /stopwatchManager/restart

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/stopwatchManager/restart

delete timers from timer custom field

/stopwatchManager/deleteTimers?issueKey=TEST-1&customFieldId=10000

query Parameters
issueKey
string
issueId
number
customFieldId
number

Responses

200

OK

get /stopwatchManager/deleteTimers

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/stopwatchManager/deleteTimers

delete timers in issues by jql from timer custom field

/stopwatchManager/deleteTimersByJql?jql=key=TEST-1&customFieldId=10000

query Parameters
jql
string
customFieldId
number

Responses

200

OK

get /stopwatchManager/deleteTimersByJql

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/stopwatchManager/deleteTimersByJql

report

Service for generate reports

Report time in status before transition

/reports/timeInStatusBeforeTransition/jql?jql=Project=TEST&timeFormat=D1&asFile=true

query Parameters
jql
string
calendarId
string

default or number

timeFormat
string (showFormat)
Enum: "DEFAULT" "D0" "D1" "D2" "D3" "D4" "D5" "D6" "D7" "D8" "D9" "D10" "D11" "D12" "D13" "D14" "D15" "D16" "D18" "D19" "D20" "D21" "D23" "D24" "D26" "D27" "D29" "D30" "D32" "D33" "D35" "D36" "D38" "D39" "D41" "D42"
exportFormat
string (exportFormat)
Enum: "JSON" "CSV" "DEFAULT"

default - from report settings

separator
string

download report as file(true) or view in browse

asFile
boolean

download report as file(true) or view in browse

Responses

200

OK

get /reports/timeInStatusBeforeTransition/jql

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/reports/timeInStatusBeforeTransition/jql

Report time in status before transition

/reports/timeInStatusBeforeTransition/issue?issueIdOrKey=10000&timeFormat=D1&asFile=true

query Parameters
issueIdOrKey
string
calendarId
string

default or number

timeFormat
string (showFormat)
Enum: "DEFAULT" "D0" "D1" "D2" "D3" "D4" "D5" "D6" "D7" "D8" "D9" "D10" "D11" "D12" "D13" "D14" "D15" "D16" "D18" "D19" "D20" "D21" "D23" "D24" "D26" "D27" "D29" "D30" "D32" "D33" "D35" "D36" "D38" "D39" "D41" "D42"
exportFormat
string (exportFormat)
Enum: "JSON" "CSV" "DEFAULT"

default - from report settings

separator
string

download report as file(true) or view in browse

asFile
boolean

download report as file(true) or view in browse

Responses

200

OK

get /reports/timeInStatusBeforeTransition/issue

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/reports/timeInStatusBeforeTransition/issue

Report time in status before transition

/reports/timeInStatusByAssignee/jql?jql=Project=TEST&timeFormat=D1&asFile=true

query Parameters
jql
string
calendarId
string

default or number

timeFormat
string (showFormat)
Enum: "DEFAULT" "D0" "D1" "D2" "D3" "D4" "D5" "D6" "D7" "D8" "D9" "D10" "D11" "D12" "D13" "D14" "D15" "D16" "D18" "D19" "D20" "D21" "D23" "D24" "D26" "D27" "D29" "D30" "D32" "D33" "D35" "D36" "D38" "D39" "D41" "D42"
exportFormat
string (exportFormat)
Enum: "JSON" "CSV" "DEFAULT"

default - from report settings

separator
string

download report as file(true) or view in browse

asFile
boolean

download report as file(true) or view in browse

statusesOrder
string (statusesOrder)
Enum: "NAME_ASC" "NAME_DESC" "ID_ASC" "ID_DESC" "TIME_ASC" "TIME_DESC" "DEFAULT"

Responses

200

OK

get /reports/timeInStatusByAssignee/jql

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/reports/timeInStatusByAssignee/jql

Report time in status before transition

/reports/timeInStatusBeforeTransition/issue?issueIdOrKey=10000&timeFormat=D1&asFile=true

query Parameters
issueIdOrKey
string
calendarId
string

default or number

timeFormat
string (showFormat)
Enum: "DEFAULT" "D0" "D1" "D2" "D3" "D4" "D5" "D6" "D7" "D8" "D9" "D10" "D11" "D12" "D13" "D14" "D15" "D16" "D18" "D19" "D20" "D21" "D23" "D24" "D26" "D27" "D29" "D30" "D32" "D33" "D35" "D36" "D38" "D39" "D41" "D42"
exportFormat
string (exportFormat)
Enum: "JSON" "CSV" "DEFAULT"

default - from report settings

separator
string

download report as file(true) or view in browse

asFile
boolean

download report as file(true) or view in browse

statusesOrder
string (statusesOrder)
Enum: "NAME_ASC" "NAME_DESC" "ID_ASC" "ID_DESC" "TIME_ASC" "TIME_DESC" "DEFAULT"

Responses

200

OK

get /reports/timeInStatusByAssignee/issue

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/reports/timeInStatusByAssignee/issue

time in status field configuration

Get all time in status field configuarations

Responses

200

OK

get /fieldConfigService/all

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/fieldConfigService/all

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Get time in status field configuaration

path Parameters
id
required
number

Responses

200

OK

get /fieldConfigService

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/fieldConfigService

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "fieldConfigId": 0,
  • "statuses":
    [
    ],
  • "showAsPanel": true,
  • "showAsPanelSW": true,
  • "calAfterMove": true,
  • "calAfterLastTransition": true,
  • "anonymousAccess": true,
  • "showField": "TOTAL_TIME",
  • "showPanel": "TOTAL_TIME",
  • "calendarId": 0,
  • "roles":
    [
    ],
  • "groups":
    [
    ],
  • "users":
    [
    ],
  • "showFieldFormat": "DEFAULT",
  • "showPanelFormat": "DEFAULT",
  • "cache": true,
  • "anonymousAccessToValue": true,
  • "rolesAccessToValue":
    [
    ],
  • "groupsAccessToToValue":
    [
    ],
  • "usersAccessToToValue":
    [
    ],
  • "fieldShowIcon": true,
  • "panelShowIcon": true,
  • "showExportFormat": "DEFAULT",
  • "showEmptyValue": true,
  • "statusesOrder": "NAME_ASC",
  • "showParentValue": true,
  • "showCStatus": true
}

Delete time in status field configuaration

path Parameters
id
required
number

Responses

200

OK

delete /fieldConfigService

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/fieldConfigService

Create time in status field configuaration

Request Body schema: application/json
id
integer
fieldConfigId
integer
statuses
Array of strings
showAsPanel
boolean
showAsPanelSW
boolean
calAfterMove
boolean
calAfterLastTransition
boolean
anonymousAccess
boolean
showField
string (showType)
Enum: "TOTAL_TIME" "TIME_IN_STATUS"

TOTAL_TIME - calculate total time in statuses. TIME_IN_STATUS - collect time for each status separately

showPanel
string (showType)
Enum: "TOTAL_TIME" "TIME_IN_STATUS"

TOTAL_TIME - calculate total time in statuses. TIME_IN_STATUS - collect time for each status separately

calendarId
number
roles
Array of numbers
groups
Array of strings
users
Array of strings
showFieldFormat
string (showFormat)
Enum: "DEFAULT" "D0" "D1" "D2" "D3" "D4" "D5" "D6" "D7" "D8" "D9" "D10" "D11" "D12" "D13" "D14" "D15" "D16" "D18" "D19" "D20" "D21" "D23" "D24" "D26" "D27" "D29" "D30" "D32" "D33" "D35" "D36" "D38" "D39" "D41" "D42"
showPanelFormat
string (showFormat)
Enum: "DEFAULT" "D0" "D1" "D2" "D3" "D4" "D5" "D6" "D7" "D8" "D9" "D10" "D11" "D12" "D13" "D14" "D15" "D16" "D18" "D19" "D20" "D21" "D23" "D24" "D26" "D27" "D29" "D30" "D32" "D33" "D35" "D36" "D38" "D39" "D41" "D42"
cache
boolean
anonymousAccessToValue
boolean
rolesAccessToValue
Array of numbers
groupsAccessToToValue
Array of strings
usersAccessToToValue
Array of strings
fieldShowIcon
boolean
panelShowIcon
boolean
showExportFormat
string (showFormat)
Enum: "DEFAULT" "D0" "D1" "D2" "D3" "D4" "D5" "D6" "D7" "D8" "D9" "D10" "D11" "D12" "D13" "D14" "D15" "D16" "D18" "D19" "D20" "D21" "D23" "D24" "D26" "D27" "D29" "D30" "D32" "D33" "D35" "D36" "D38" "D39" "D41" "D42"
showEmptyValue
boolean
statusesOrder
string (statusesOrder)
Enum: "NAME_ASC" "NAME_DESC" "ID_ASC" "ID_DESC" "TIME_ASC" "TIME_DESC" "DEFAULT"
showParentValue
boolean
showCStatus
boolean

Responses

200

OK

post /fieldConfigService

BASE REST URL

http://{baseUrl}/rest/jibrok/timeinstatus/1.0/fieldConfigService

Request samples

Content type
application/json
Copy
Expand all Collapse all
{