Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameTypeDescription
nameStringName of property.
displayNameStringDisplay name of property
dataTypeStringData type for property
descriptionStringDescription for property
isRequiredBooleanTrue if property is required
isEncryptedBooleanTrue if property value will be encrypted
isActiveBooleanTrue if property is active

Response Codes

HTTP Code
Description
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

Code Block
themeEclipse
titleIssue Tracking System - 11101
[
{
	"name":"Jira",
	"properties":
	[
	{
		"name":"JIRA_URL",
		"displayName":"JiraURL",
		"description":"JiraURL(http://myjira.atlassian.net)",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_PORT",
		"displayName":"JiraPort",
		"description":"JiraPort",
		"dataType":"Integer",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_TICKET_URL_PATTERN",
		"displayName":"JiraTicketURLPattern",
		"description":"JiraTicketURLPattern(/browse/{JIRA_ISSUE})",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_TICKET_REST_PATTERN",
		"displayName":"JiraRestAPIPattern",
		"description":"JiraRestAPIPattern(/rest/api/2/issue/{JIRA_ISSUE})",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_USER_NAME",
		"displayName":"JiraUser",
		"description":"JiraUserName",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_PASSWORD",
		"displayName":"JiraPassword",
		"description":"JiraPassword",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":true
	}
	],
	"id":1
}
]

...