Workzone - REST API (0.0.1)

Download OpenAPI specification:

getSignApprovers

path Parameters

pullReqId required	integer <int64>
projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"slug": "jcitizen",
"emailAddress": "jane@example.com",
"empty": true
}
]

getSignatures

path Parameters

pullReqId required	integer <int64>
projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"eventType": "APPROVED",
"projectKey": "string",
"repoSlug": "string",
"pullRequestId": 0,
"user": {"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"slug": "jcitizen",
"emailAddress": "jane@example.com",
"empty": true
},
"dateTime": "string",
"comment": "string"
}
]

isSignRequired

path Parameters

pullReqId required	integer <int64>
projectKey required	string
repoSlug required	string
userId required	integer <int32>

Responses

signApprove

path Parameters

pullReqId required	integer <int64>
projectKey required	string
repoSlug required	string

Request Body schema: application/json

signapproveUser	string
signapprovePwd	string
pullReqId	integer <int32>
repoSlug	string
projectKey	string

Responses

Request samples

Payload

Content type

application/json

{"signapproveUser": "string",
"signapprovePwd": "string",
"pullReqId": 0,
"repoSlug": "string",
"projectKey": "string"
}

getGlobalConfig

Responses

Response samples

default

Content type

application/json

{"enableReviewerNotifications": true,
"enableMergeConditionVeto": true,
"enableNeedsWorkVeto": true,
"enableImmediateMerge": true,
"disablePullRequestSignatures": true,
"reviewersGroupMembersLimit": 0,
"groupsPerUserLimit": 0,
"maxPullRequestAgeDays": 0,
"auditLogPriority": "string",
"coverageLevel": "string",
"enableRescopeConflictNotifications": true,
"logAutomergeFailure": true,
"maxAutomergeFailureRetries": 0,
"customSupportUrl": "string"
}

setGlobalConfig

Request Body schema: application/json

enableReviewerNotifications	boolean
enableMergeConditionVeto	boolean
enableNeedsWorkVeto	boolean
enableImmediateMerge	boolean
disablePullRequestSignatures	boolean
reviewersGroupMembersLimit	integer <int32>
groupsPerUserLimit	integer <int32>
maxPullRequestAgeDays	integer <int32>
auditLogPriority	string
coverageLevel	string
enableRescopeConflictNotifications	boolean
logAutomergeFailure	boolean
maxAutomergeFailureRetries	integer <int32>
customSupportUrl	string

Responses

Request samples

Payload

Content type

application/json

{"enableReviewerNotifications": true,
"enableMergeConditionVeto": true,
"enableNeedsWorkVeto": true,
"enableImmediateMerge": true,
"disablePullRequestSignatures": true,
"reviewersGroupMembersLimit": 0,
"groupsPerUserLimit": 0,
"maxPullRequestAgeDays": 0,
"auditLogPriority": "string",
"coverageLevel": "string",
"enableRescopeConflictNotifications": true,
"logAutomergeFailure": true,
"maxAutomergeFailureRetries": 0,
"customSupportUrl": "string"
}

getGlobalConfig_1

path Parameters

projectKey

required

string

Responses

setGlobalConfig_1

path Parameters

projectKey

required

string

Request Body schema: application/json

enableReviewerNotifications	boolean
enableMergeConditionVeto	boolean
enableNeedsWorkVeto	boolean
enableImmediateMerge	boolean
disablePullRequestSignatures	boolean
reviewersGroupMembersLimit	integer <int32>
groupsPerUserLimit	integer <int32>
maxPullRequestAgeDays	integer <int32>
auditLogPriority	string
coverageLevel	string
enableRescopeConflictNotifications	boolean
logAutomergeFailure	boolean
maxAutomergeFailureRetries	integer <int32>
customSupportUrl	string

Responses

Request samples

Payload

Content type

application/json

{"enableReviewerNotifications": true,
"enableMergeConditionVeto": true,
"enableNeedsWorkVeto": true,
"enableImmediateMerge": true,
"disablePullRequestSignatures": true,
"reviewersGroupMembersLimit": 0,
"groupsPerUserLimit": 0,
"maxPullRequestAgeDays": 0,
"auditLogPriority": "string",
"coverageLevel": "string",
"enableRescopeConflictNotifications": true,
"logAutomergeFailure": true,
"maxAutomergeFailureRetries": 0,
"customSupportUrl": "string"
}

getGlobalConfig_2

path Parameters

projectKey required	string
repoSlug required	string

Responses

setGlobalConfig_2

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

enableReviewerNotifications	boolean
enableMergeConditionVeto	boolean
enableNeedsWorkVeto	boolean
enableImmediateMerge	boolean
disablePullRequestSignatures	boolean
reviewersGroupMembersLimit	integer <int32>
groupsPerUserLimit	integer <int32>
maxPullRequestAgeDays	integer <int32>
auditLogPriority	string
coverageLevel	string
enableRescopeConflictNotifications	boolean
logAutomergeFailure	boolean
maxAutomergeFailureRetries	integer <int32>
customSupportUrl	string

Responses

Request samples

Payload

Content type

application/json

{"enableReviewerNotifications": true,
"enableMergeConditionVeto": true,
"enableNeedsWorkVeto": true,
"enableImmediateMerge": true,
"disablePullRequestSignatures": true,
"reviewersGroupMembersLimit": 0,
"groupsPerUserLimit": 0,
"maxPullRequestAgeDays": 0,
"auditLogPriority": "string",
"coverageLevel": "string",
"enableRescopeConflictNotifications": true,
"logAutomergeFailure": true,
"maxAutomergeFailureRetries": 0,
"customSupportUrl": "string"
}

resetGroupUsersCache

path Parameters

command required	string
authkey required	string

Responses

getProjectAutomergers

path Parameters

projectKey

required

string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}
]

setProjectAutoMergers

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
approvalQuotaEnabled	boolean
approvalQuota	string
approvalCount	integer <int32>
mandatoryApprovalCount	integer <int32>
deleteSourceBranch	boolean
watchBuildResult	boolean
watchTaskCompletion	boolean
requiredBuildsCount	integer <int32>
requiredSignaturesCount	integer <int32>
groupQuota	integer <int32>
mergeCondition	string
mergeStrategyId	string
ignoreContributingReviewersApproval	boolean
enableNeedsWorkVeto	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}

deleteProjectAutomergers

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
approvalQuotaEnabled	boolean
approvalQuota	string
approvalCount	integer <int32>
mandatoryApprovalCount	integer <int32>
deleteSourceBranch	boolean
watchBuildResult	boolean
watchTaskCompletion	boolean
requiredBuildsCount	integer <int32>
requiredSignaturesCount	integer <int32>
groupQuota	integer <int32>
mergeCondition	string
mergeStrategyId	string
ignoreContributingReviewersApproval	boolean
enableNeedsWorkVeto	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}

getProjectAutomergersList

path Parameters

projectKey

required

string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}
]

setProjectAutoMergersList

path Parameters

projectKey

required

string

Request Body schema: application/json

Array

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
approvalQuotaEnabled	boolean
approvalQuota	string
approvalCount	integer <int32>
mandatoryApprovalCount	integer <int32>
deleteSourceBranch	boolean
watchBuildResult	boolean
watchTaskCompletion	boolean
requiredBuildsCount	integer <int32>
requiredSignaturesCount	integer <int32>
groupQuota	integer <int32>
mergeCondition	string
mergeStrategyId	string
ignoreContributingReviewersApproval	boolean
enableNeedsWorkVeto	boolean

Responses

Request samples

Payload

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}
]

deleteProjectAutomergersList

path Parameters

projectKey

required

string

Responses

getProjectReviewers

path Parameters

projectKey

required

string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}
]

setProjectReviewers

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
	Array of objects
mandatoryGroups	Array of strings
topSuggestedReviewers	integer <int32>
daysInPast	integer <int32>
	Array of objects (RestFilePathReviewers)

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}

deleteProjectReviewers

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
	Array of objects
mandatoryGroups	Array of strings
topSuggestedReviewers	integer <int32>
daysInPast	integer <int32>
	Array of objects (RestFilePathReviewers)

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}

getProjectSignapprovers

path Parameters

projectKey

required

string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}
]

setProjectSignApprovers

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
addAsReviewers	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}

deleteProjectSignapprovers

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
addAsReviewers	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}

getProjectReviewersList

path Parameters

projectKey

required

string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}
]

setProjectReviewersList

path Parameters

projectKey

required

string

Request Body schema: application/json

Array

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
	Array of objects
mandatoryGroups	Array of strings
topSuggestedReviewers	integer <int32>
daysInPast	integer <int32>
	Array of objects (RestFilePathReviewers)

Responses

Request samples

Payload

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}
]

getProjectSignapproversList

path Parameters

projectKey

required

string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}
]

setProjectSignApproversList

path Parameters

projectKey

required

string

Request Body schema: application/json

Array

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
addAsReviewers	boolean

Responses

Request samples

Payload

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}
]

getMergeVeto

path Parameters

projectKey required	string
repoSlug required	string
prId required	integer <int64>

Responses

Response samples

default

Content type

application/json

"string"

getBranchAutomergers

path Parameters

projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}
]

setBranchAutoMergers

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
approvalQuotaEnabled	boolean
approvalQuota	string
approvalCount	integer <int32>
mandatoryApprovalCount	integer <int32>
deleteSourceBranch	boolean
watchBuildResult	boolean
watchTaskCompletion	boolean
requiredBuildsCount	integer <int32>
requiredSignaturesCount	integer <int32>
groupQuota	integer <int32>
mergeCondition	string
mergeStrategyId	string
ignoreContributingReviewersApproval	boolean
enableNeedsWorkVeto	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}

deleteBranchAutomergers

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
approvalQuotaEnabled	boolean
approvalQuota	string
approvalCount	integer <int32>
mandatoryApprovalCount	integer <int32>
deleteSourceBranch	boolean
watchBuildResult	boolean
watchTaskCompletion	boolean
requiredBuildsCount	integer <int32>
requiredSignaturesCount	integer <int32>
groupQuota	integer <int32>
mergeCondition	string
mergeStrategyId	string
ignoreContributingReviewersApproval	boolean
enableNeedsWorkVeto	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}

getBranchAutomergersList

path Parameters

projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}
]

setBranchAutomergersList

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

Array

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
approvalQuotaEnabled	boolean
approvalQuota	string
approvalCount	integer <int32>
mandatoryApprovalCount	integer <int32>
deleteSourceBranch	boolean
watchBuildResult	boolean
watchTaskCompletion	boolean
requiredBuildsCount	integer <int32>
requiredSignaturesCount	integer <int32>
groupQuota	integer <int32>
mergeCondition	string
mergeStrategyId	string
ignoreContributingReviewersApproval	boolean
enableNeedsWorkVeto	boolean

Responses

Request samples

Payload

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}
]

deleteBranchAutomergersList

path Parameters

projectKey required	string
repoSlug required	string

Responses

getBranchReviewers

path Parameters

projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}
]

setBranchReviewers

Set repository reviewers for branch

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
	Array of objects
mandatoryGroups	Array of strings
topSuggestedReviewers	integer <int32>
daysInPast	integer <int32>
	Array of objects (RestFilePathReviewers)

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}

Response samples

400
500

Content type

application/json

"string"

deleteBranchReviewers

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
	Array of objects
mandatoryGroups	Array of strings
topSuggestedReviewers	integer <int32>
daysInPast	integer <int32>
	Array of objects (RestFilePathReviewers)

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}

getBranchReviewersList

path Parameters

projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}
]

setBranchReviewersList

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

Array

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
	Array of objects
mandatoryGroups	Array of strings
topSuggestedReviewers	integer <int32>
daysInPast	integer <int32>
	Array of objects (RestFilePathReviewers)

Responses

Request samples

Payload

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryGroups": ["string"
],
"topSuggestedReviewers": 0,
"daysInPast": 0,
"filePathReviewers": [{"filePathPattern": "string",
"includeExcludeEnabled": true,
"includeFilePathPattern": ["string"
],
"excludeFilePathPattern": ["string"
],
"users": [{"property1": { },
"property2": { }
}
],
"approvalCount": 0,
"groups": ["string"
],
"groupQuota": 0,
"mandatoryUsers": [{"property1": { },
"property2": { }
}
],
"mandatoryApprovalCount": 0,
"mandatoryGroups": ["string"
],
"mandatoryGroupQuota": 0
}
]
}
]

deleteBranchReviewersList

path Parameters

projectKey required	string
repoSlug required	string

Responses

getSignapprovers

path Parameters

projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}
]

setSignApprovers

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
addAsReviewers	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}

deleteSignapprovers

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
addAsReviewers	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}

getSignapproversList

path Parameters

projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}
]

setSignApproversList

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

Array

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
	Array of objects
groups	Array of strings
addAsReviewers	boolean

Responses

Request samples

Payload

Content type

application/json

[{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"users": [{"property1": { },
"property2": { }
}
],
"groups": ["string"
],
"addAsReviewers": true
}
]

deleteSignapproversList

path Parameters

projectKey required	string
repoSlug required	string

Responses

getBranchAutomergerConfigForPullRequest

Get merge configuration for pull request

path Parameters

projectKey required	string
repoSlug required	string
prId required	integer <int64>

Responses

Response samples

default

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"automergeUsers": [{"property1": { },
"property2": { }
}
],
"approvalQuotaEnabled": true,
"approvalQuota": "string",
"approvalCount": 0,
"mandatoryApprovalCount": 0,
"deleteSourceBranch": true,
"watchBuildResult": true,
"watchTaskCompletion": true,
"requiredBuildsCount": 0,
"requiredSignaturesCount": 0,
"groupQuota": 0,
"mergeCondition": "string",
"mergeStrategyId": "string",
"ignoreContributingReviewersApproval": true,
"enableNeedsWorkVeto": true
}

getRepoWorkflowProperties

path Parameters

projectKey required	string
repoSlug required	string

Responses

Response samples

default

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"pushAfterPullReq": true,
"unapprovePullReqSrcCommit": true,
"unapprovePullReq": true,
"unapprovePullReqTargetRefChange": true,
"enableMergeConditionVeto": true,
"inheritedMergeConditionVetoEnabled": true
}

updateRepoWorkflowProperties

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
pushAfterPullReq	boolean
unapprovePullReqSrcCommit	boolean
unapprovePullReq	boolean
unapprovePullReqTargetRefChange	boolean
enableMergeConditionVeto	boolean
inheritedMergeConditionVetoEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"pushAfterPullReq": true,
"unapprovePullReqSrcCommit": true,
"unapprovePullReq": true,
"unapprovePullReqTargetRefChange": true,
"enableMergeConditionVeto": true,
"inheritedMergeConditionVetoEnabled": true
}

setRepoWorkflowProperties

path Parameters

projectKey required	string
repoSlug required	string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
pushAfterPullReq	boolean
unapprovePullReqSrcCommit	boolean
unapprovePullReq	boolean
unapprovePullReqTargetRefChange	boolean
enableMergeConditionVeto	boolean
inheritedMergeConditionVetoEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"pushAfterPullReq": true,
"unapprovePullReqSrcCommit": true,
"unapprovePullReq": true,
"unapprovePullReqTargetRefChange": true,
"enableMergeConditionVeto": true,
"inheritedMergeConditionVetoEnabled": true
}

removeRepoWorkflowProperties

path Parameters

projectKey required	string
repoSlug required	string

Responses

getWorkflowProperties

path Parameters

projectKey

required

string

Responses

Response samples

default

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"pushAfterPullReq": true,
"unapprovePullReqSrcCommit": true,
"unapprovePullReq": true,
"unapprovePullReqTargetRefChange": true,
"enableMergeConditionVeto": true,
"inheritedMergeConditionVetoEnabled": true
}

updateWorkflowProperties

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
pushAfterPullReq	boolean
unapprovePullReqSrcCommit	boolean
unapprovePullReq	boolean
unapprovePullReqTargetRefChange	boolean
enableMergeConditionVeto	boolean
inheritedMergeConditionVetoEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"pushAfterPullReq": true,
"unapprovePullReqSrcCommit": true,
"unapprovePullReq": true,
"unapprovePullReqTargetRefChange": true,
"enableMergeConditionVeto": true,
"inheritedMergeConditionVetoEnabled": true
}

setWorkflowProperties

path Parameters

projectKey

required

string

Request Body schema: application/json

projectKey	string
repoSlug	string
refName	string
refPattern	string
srcRefName	string
srcRefPattern	string
pushAfterPullReq	boolean
unapprovePullReqSrcCommit	boolean
unapprovePullReq	boolean
unapprovePullReqTargetRefChange	boolean
enableMergeConditionVeto	boolean
inheritedMergeConditionVetoEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"projectKey": "string",
"repoSlug": "string",
"refName": "string",
"refPattern": "string",
"srcRefName": "string",
"srcRefPattern": "string",
"pushAfterPullReq": true,
"unapprovePullReqSrcCommit": true,
"unapprovePullReq": true,
"unapprovePullReqTargetRefChange": true,
"enableMergeConditionVeto": true,
"inheritedMergeConditionVetoEnabled": true
}

removeWorkflowProperties

path Parameters

projectKey

required

string