Versions Compared

Key

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

Include Page
REST V1 Authentication
REST V1 Authentication

Table of Contents
maxLevel2

...

Properties definition has following attributes.

NameTypeDescription
nameStringName of property
.
displayNameStringDisplay name of property
dataTypeStringData type for property
subDataTypeStringSub-Data type for property
descriptionStringDescription for property
isRequiredBooleanTrue if property is required
isEncryptedBooleanTrue if property value will be encrypted
isActiveBooleanTrue if property is active
defaultValueStringDefault value for property
scopeStringScope of the property
listDataList<String>Possible string values for the property, if property is type enum
isDefaultValueExpressionBooleanWhether value is expression or literal by default
isMultiSelectBooleanWhether multiple values are allowed

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",
                "defaultValue": null,
		
                "displayName": "JiraURLJira URL",
		                "description": "JiraURLJira URL (http://myjira.atlassian.net)",
		
                "scope": "INST",
                "dataType": "String",
		                "isRequired": true,
		,
                "listData": [
                    null
                ],
                "isActive": true,
		"isEncrypted":false
	},
	{
		"name":"JIRA_PORT",
		"displayName":"JiraPort",
		"description":"JiraPort",
		"dataType":"Integer",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":false
	},
	{
		"name":
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": "URL"
            },
            {
                "name": "JIRA_PORT",
                "defaultValue": null,
                "displayName": "Jira Port",
                "description": "Jira Port",
                "scope": "INST",
                "dataType": "Integer",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": null
            },
            {
                "name": "JIRA_TICKET_URL_PATTERN",
                "defaultValue": "/browse/{JIRA_ISSUE}",
		
                "displayName":"JiraTicketURLPattern",
		 "Jira Ticket URL Pattern",
                "description":"JiraTicketURLPattern "Jira Ticket URL Pattern (/browse/{JIRA_ISSUE})",
		                "scope": "INST",
                "dataType": "String",
		
                "isRequired": true,
                "listData": [
                    null
                ],
		
                "isActive": true,
		"isEncrypted":false
	},
	{
		"name":                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": "URL"
            },
            {
                "name": "JIRA_TICKET_REST_PATTERN",
		
                "defaultValue": "/rest/api/2/issue/{JIRA_ISSUE}",
                "displayName":"JiraRestAPIPattern "Jira Rest API Pattern",
		
                "description":"JiraRestAPIPattern "Jira Rest API Pattern (/rest/api/2/issue/{JIRA_ISSUE})",
                "scope": "INST",
		
                "dataType": "String",
		
                "isRequired": true,
		
                "listData": [
                    null
                ],
                "isActive": true,
		"isEncrypted":false
	},
	{
		"name":
                "isEncrypted": false,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": "URL"
            },
            {
                "name": "JIRA_USER_NAME",
                "defaultValue": null,
		
                "displayName": "JiraUserJira User",
		"description":"JiraUserName",
		
                "description": "Jira User Name",
                "scope": "INST",
                "dataType": "String",
		
                "isRequired": true,
                "listData": [
                    null
                ],
		
                "isActive": true,
		
                "isEncrypted": false
	},
	{
		,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": null
            },
            {
                "name": "JIRA_PASSWORD",
                "defaultValue": null,
		
                "displayName":"JiraPassword",
		"description":"JiraPassword",
		"dataType":"String",
		"isRequired":true,
		"isActive":true,
		"isEncrypted":true
	}
	],
	"id":1
}
] "Jira API Token/Password",
                "description": "Jira API Token or Password. Click <a href=\"https://confluence.atlassian.com/cloud/api-tokens-938839638.html\" target=\"_blank\">here</a> to learn more about API tokens and how to create them.",
                "scope": "INST",
                "dataType": "String",
                "isRequired": true,
                "listData": [
                    null
                ],
                "isActive": true,
                "isEncrypted": true,
                "isDefaultValueExpression": false,
                "isMultiselect": false,
                "subDataType": null
            }
        ],
        "id": 1
    }
]