RESTful API Help

Get Setting

Http Method

GET

End Point

/~api/projects/{projectId}/setting

Placeholder	Description	Example
{projectId}	Project Id	1

Response

Operation Successful

Status Code

200

Response Body

Content Type: application/json
Example: {

"serviceDeskName" : "string" ,
"branchProtections" : [ {

"enabled" : true ,
"branches" : "string" ,
"userMatch" : "string" ,
"preventForcedPush" : true ,
"preventDeletion" : true ,
"preventCreation" : true ,
"commitSignatureRequired" : true ,
"enforceConventionalCommits" : true ,
"commitTypes" : [ "string" ] ,
"commitScopes" : [ "string" ] ,
"maxCommitMessageLineLength" : 1 ,
"reviewRequirement" : "string" ,
"jobNames" : [ "string" ] ,
"fileProtections" : [ {

"paths" : "string" ,
"reviewRequirement" : "string" ,
"jobNames" : [ "string" ]

} ] ,
"requireStrictBuilds" : true

} ] ,
"tagProtections" : [ {

"enabled" : true ,
"tags" : "string" ,
"userMatch" : "string" ,
"preventUpdate" : true ,
"preventDeletion" : true ,
"preventCreation" : true ,
"commitSignatureRequired" : true

} ] ,
"issueSetting" : {

"listFields" : [ "string" ] ,
"listLinks" : [ "string" ] ,
"boardSpecs" : [ {

"name" : "string" ,
"baseQuery" : "string" ,
"backlogBaseQuery" : "string" ,
"identifyField" : "string" ,
"columns" : [ "string" ] ,
"displayFields" : [ "string" ] ,
"displayLinks" : [ "string" ] ,
"editColumns" : [ "string" ]

} ] ,
"namedQueries" : [ {

"name" : "string" ,
"query" : "string"

} ]

} ,
"buildSetting" : {

"listParams" : [ "string" ] ,
"namedQueries" : [ {

"name" : "string" ,
"query" : "string"

} ] ,
"jobProperties" : [ {

"name" : "string" ,
"value" : "string"

} ] ,
"jobSecrets" : [ {

"name" : "string" ,
"value" : "string" ,
"authorization" : "string"

} ] ,
"buildPreservations" : [ {

"condition" : "string" ,
"count" : 1

} ] ,
"defaultFixedIssueFilters" : [ {

"jobNames" : "string" ,
"issueQuery" : "string"

} ]

} ,
"pullRequestSetting" : {

"namedQueries" : [ {

"name" : "string" ,
"query" : "string"

} ] ,
"defaultMergeStrategy" : "CREATE_MERGE_COMMIT"

} ,
"namedCommitQueries" : [ {

"name" : "string" ,
"query" : "string"

} ] ,
"namedCodeCommentQueries" : [ {

"name" : "string" ,
"query" : "string"

} ] ,
"webHooks" : [ {

"postUrl" : "string" ,
"eventTypes" : [ "CODE_PUSH" ] ,
"secret" : "string"

} ] ,
"contributedSettings" : {

"string" : {

"@type" : "DiscordNotificationSetting" ,

"notifications" : [ {

"channelNotification" : {

"webhookUrl" : "string" ,
"issues" : true ,
"issueQuery" : "string" ,
"pullRequests" : true ,
"pullRequestQuery" : "string" ,
"builds" : true ,
"buildQuery" : "string" ,
"codePush" : true ,
"commitQuery" : "string" ,
"codeComments" : true ,
"codeCommentQuery" : "string"

}

} ]

}

}

}

Operation Failed

Status code: Status code other than 200 indicating the error type
Response Body: Error detail of content type "text/plain"

cURL Example

$ curl -u <login name>:<password or access token> https://crash.software/~api/projects/1/setting