Issue Tracker Plugins
Get all Issue Tracker Plugins
This endpoint retrieves a list of Issue Tracker Integration Plugin resources.
GET /api/v2/plugins/issue-tracker/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"results": [
{
"id": "github",
"name": "GitHub",
"short_name": "GitHub",
"command": "sync_github",
"sections": [
{
"label": null,
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_project",
"label": "Repository name",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": 255,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"project"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Connection Details",
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_method",
"label": "Protocol",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "https",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "https",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "https",
"value": "https",
"disabled": false
},
{
"label": "http",
"value": "http",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_server",
"label": "Server",
"add_label": "",
"description": "",
"field_type": "string",
"default": "api.github.com",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "bugs.server.com",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_context_root",
"label": "Context Root",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "/",
"features": [],
"scope": [
"system"
],
"help_text": "Normally left empty unless the service is installed at a non-standard location",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "github_repo_owner",
"label": "Owner of this GitHub Repository",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Credentials",
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_auth_mode",
"label": "Authentication Method",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "api_token",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "api_token",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "API Token",
"value": "api_token",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": true,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_api_token",
"label": "GitHub Token",
"add_label": "",
"description": "",
"field_type": "masked_string",
"default": null,
"readonly": false,
"max_length": 1024,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Create a Personal Access Token (with \"repo\" or \"public_repo\" scope) under your GitHub account. [Click here](https://github.com/settings/tokens) if you\\`re using github.com",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {
"issue_tracker_auth_mode": "api_token"
},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Client Side Certificate",
"optional": true,
"description": "Settings for using a client side certificate during synchronization.",
"fields": [
{
"name": "issue_tracker_client_certificate",
"label": "Client Certificate",
"add_label": "",
"description": "A PEM encoded X509 certificate to be used by SD Elements as the client certificate.",
"field_type": "file_upload_text_field",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "Browse...",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_client_key",
"label": "Private Key",
"add_label": "",
"description": "A PEM encoded private key for the certificate. Key sizes up to 2048 bits are supported. This key will be transferred and stored securely. Once set, it cannot be viewed again.",
"field_type": "file_upload_text_field",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "Browse...",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": true,
"field_metadata": {}
},
{
"name": "issue_tracker_encryption_password",
"label": "Private Key Password",
"add_label": "",
"description": "If the private key is encrypted, specify the decryption password here. This value will only be used once to decrypt the key and will not be stored.",
"field_type": "masked_string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {
"issue_tracker_client_key__isdirty": true,
"issue_tracker_client_key__isempty": false
},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Tasks to Synchronize",
"optional": false,
"description": null,
"fields": [
{
"name": "task_filter",
"label": "Type",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "risk_policy",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "risk_policy",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Sync all tasks",
"value": "all_tasks",
"disabled": false
},
{
"label": "Sync Risk Policy tasks",
"value": "risk_policy",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced GitHub Configuration",
"optional": true,
"description": "Define how a GitHub status relates to an SD Elements status and vice-versa. For example, the 'GitHub-Done' status can map to the 'SD Elements-Complete' status. This helps clarify how your GitHub workflow is reflected in SD Elements.",
"fields": [
{
"name": "github_duplicate_label",
"label": "GitHub duplicate label",
"add_label": "",
"description": "",
"field_type": "string",
"default": "duplicate",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "duplicate",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "github_issue_label",
"label": "GitHub issue label",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Synchronization",
"optional": true,
"description": "Settings for synchronizing SD Elements tasks.",
"fields": [
{
"name": "conflict_policy",
"label": "Choose Authoritative Source",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "issue_tracker",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "issue_tracker",
"features": [],
"scope": [
"system"
],
"help_text": "The de facto source for the status of an SD Elements task",
"options": [
{
"label": "GitHub",
"value": "issue_tracker",
"disabled": false
},
{
"label": "SD Elements",
"value": "sde",
"disabled": false
},
{
"label": "Last Status Change",
"value": "timestamp",
"disabled": true
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "how_tos_in_scope",
"label": "Include Code Sample How-To's",
"add_label": "",
"description": "Code sample How-To's in task descriptions",
"field_type": "boolean",
"default": false,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "False",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "training_in_scope",
"label": "Include Training Content",
"add_label": "",
"description": "Include available Training Course content in task descriptions",
"field_type": "boolean",
"default": false,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "False",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Tasks Filtering",
"optional": true,
"description": "Selecting any of the below options will further filter the type of tasks to synchronize.",
"fields": [
{
"name": "sde_min_priority",
"label": "Tasks having a minimum priority",
"add_label": "",
"description": "",
"field_type": "select",
"default": 1,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "1",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "10",
"value": 10,
"disabled": false
},
{
"label": "9",
"value": 9,
"disabled": false
},
{
"label": "8",
"value": 8,
"disabled": false
},
{
"label": "7 - High",
"value": 7,
"disabled": false
},
{
"label": "6",
"value": 6,
"disabled": false
},
{
"label": "5",
"value": 5,
"disabled": false
},
{
"label": "4 - Medium",
"value": 4,
"disabled": false
},
{
"label": "3",
"value": 3,
"disabled": false
},
{
"label": "2",
"value": 2,
"disabled": false
},
{
"label": "1 - Low",
"value": 1,
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_statuses_in_scope",
"label": "Tasks with status meaning",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": "TODO",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "TODO",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Done",
"value": "DONE",
"disabled": false
},
{
"label": "Todo",
"value": "TODO",
"disabled": false
},
{
"label": "N/A",
"value": "NA",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_phases",
"label": "Limit to tasks having these phases",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Activities",
"value": "activities",
"disabled": false
},
{
"label": "Requirements",
"value": "requirements",
"disabled": false
},
{
"label": "Architecture & Design",
"value": "architecture-design",
"disabled": false
},
{
"label": "Development",
"value": "development",
"disabled": false
},
{
"label": "Deployment",
"value": "deployment",
"disabled": false
},
{
"label": "Testing",
"value": "testing",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_tags_filter",
"label": "Tasks having all of the following tags",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "tag1,tag2",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_verification_filter",
"label": "Tasks with verification status",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Filter tasks based on their verification status",
"options": [
{
"label": "No Status",
"value": "none",
"disabled": false
},
{
"label": "Partial Pass",
"value": "partial",
"disabled": false
},
{
"label": "Pass",
"value": "pass",
"disabled": false
},
{
"label": "Fail",
"value": "fail",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced Issue Tracker Options",
"optional": true,
"description": "Advanced configuration options.",
"fields": [
{
"name": "issue_tracker_title_format",
"label": "Issue Tracker Title Format",
"add_label": "",
"description": "Customize the issue titles created in the Issue Tracker by choosing one of the templates below.",
"field_type": "select",
"default": "$task_id $title",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "$task_id $title",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "T1: Task title",
"value": "$task_id $title",
"disabled": false
},
{
"label": "[Application - Project] T1: Task title",
"value": "[$application - $project] $task_id $title",
"disabled": false
},
{
"label": "[Application - Context] T1: Task title",
"value": "[$application - $context] $task_id $title",
"disabled": false
},
{
"label": "[Context] T1: Task title",
"value": "[$context] $task_id $title",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_validate_cert",
"label": "Enforce Certificate Validation",
"add_label": "",
"description": "Bypasses certificate validation if unchecked (insecure, only for testing purposes)",
"field_type": "boolean",
"default": true,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "True",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_context",
"label": "Issue Tracker context",
"add_label": "",
"description": "Bind like projects together by providing meta information below. Set a value here if the connection has been configured to create custom issue titles containing 'Context'.",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [
"advanced_issue_tracker"
],
"scope": [
"project"
],
"help_text": "Bind a set of tasks using a certain value. This is applicable only when custom titles are selected having the entry 'Context'",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
}
]
},
{
"id": "jira",
"name": "JIRA",
"short_name": "JIRA",
"command": "sync_jira",
"sections": [
{
"label": null,
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_project",
"label": "JIRA Project Key",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": 255,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"project"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Connection Details",
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_method",
"label": "Protocol",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "https",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "https",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "https",
"value": "https",
"disabled": false
},
{
"label": "http",
"value": "http",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_server",
"label": "Server",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "your-company.atlassian.net",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_context_root",
"label": "Context Root",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "/",
"features": [],
"scope": [
"system"
],
"help_text": "Normally left empty unless the service is installed at a non-standard location",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Credentials",
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_auth_mode",
"label": "Authentication Method",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "basic",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "basic",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Basic",
"value": "basic",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": true,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_user",
"label": "JIRA Username",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": 255,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {
"issue_tracker_auth_mode": "basic"
},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_pass",
"label": "JIRA Password/API Token",
"add_label": "",
"description": "",
"field_type": "masked_string",
"default": null,
"readonly": false,
"max_length": 255,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {
"issue_tracker_auth_mode": "basic"
},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Client Side Certificate",
"optional": true,
"description": "Settings for using a client side certificate during synchronization.",
"fields": [
{
"name": "issue_tracker_client_certificate",
"label": "Client Certificate",
"add_label": "",
"description": "A PEM encoded X509 certificate to be used by SD Elements as the client certificate.",
"field_type": "file_upload_text_field",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "Browse...",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_client_key",
"label": "Private Key",
"add_label": "",
"description": "A PEM encoded private key for the certificate. Key sizes up to 2048 bits are supported. This key will be transferred and stored securely. Once set, it cannot be viewed again.",
"field_type": "file_upload_text_field",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "Browse...",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": true,
"field_metadata": {}
},
{
"name": "issue_tracker_encryption_password",
"label": "Private Key Password",
"add_label": "",
"description": "If the private key is encrypted, specify the decryption password here. This value will only be used once to decrypt the key and will not be stored.",
"field_type": "masked_string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {
"issue_tracker_client_key__isdirty": true,
"issue_tracker_client_key__isempty": false
},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Tasks to Synchronize",
"optional": false,
"description": null,
"fields": [
{
"name": "task_filter",
"label": "Type",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "risk_policy",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "risk_policy",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Sync all tasks",
"value": "all_tasks",
"disabled": false
},
{
"label": "Sync Risk Policy tasks",
"value": "risk_policy",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced JIRA Configuration",
"optional": false,
"description": "Define how a JIRA status relates to an SD Elements status and vice-versa. For example, the 'JIRA-In Progress' status can map to the 'SD Elements-Incomplete' status. This helps clarify how your JIRA workflow is reflected in SD Elements.",
"fields": [
{
"name": "sde_to_issue_tracker_status_mapping",
"label": "Map an SD Elements status to a JIRA status",
"add_label": "+ Add Status Mapping",
"description": "",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Ensure that the ‘Incomplete’, ‘Complete’, and ‘Not Applicable’ statuses in SD Elements are mapped to related statuses in JIRA. Any unmapped custom statuses will use these mappings based on their meaning.",
"options": [],
"key_hint_text_mapping": {
"__default__": "SD Elements Status"
},
"value_hint_text_mapping": {
"TS1": "ex. Done",
"TS2": "ex. In progress",
"TS3": "ex. N/A or similar",
"__default__": "JIRA Status"
},
"autocomplete": true,
"key_options": [
{
"label": "Complete",
"value": "TS1",
"disabled": false
},
{
"label": "Incomplete",
"value": "TS2",
"disabled": false
},
{
"label": "Not Applicable",
"value": "TS3",
"disabled": false
}
],
"value_options": null,
"default_key_value_mapping": [
[
"TS1",
""
],
[
"TS2",
""
],
[
"TS3",
""
]
],
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_to_sde_status_mapping",
"label": "Map a JIRA status to an SD Elements status",
"add_label": "+ Add Status Mapping",
"description": "",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Map a JIRA status for all required statuses in SD Elements ('Incomplete', ‘Complete’, and ‘Not Applicable’) before adding any new mappings. Any JIRA status that is not mapped here will map to an SD Elements ‘Incomplete' status by default.",
"options": [],
"key_hint_text_mapping": {
"TS1": "ex. Done",
"TS2": "ex. In progress",
"TS3": "ex. N/A or similar",
"__default__": "JIRA Status"
},
"value_hint_text_mapping": {
"__default__": "SD Elements Status"
},
"autocomplete": true,
"key_options": null,
"value_options": [
{
"label": "Complete",
"value": "TS1",
"disabled": false
},
{
"label": "Incomplete",
"value": "TS2",
"disabled": false
},
{
"label": "Not Applicable",
"value": "TS3",
"disabled": false
}
],
"default_key_value_mapping": [
[
"",
"TS1"
],
[
"",
"TS2"
],
[
"",
"TS3"
]
],
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_fallback_state",
"label": "Unmapped Status Fallback",
"add_label": "",
"description": "",
"field_type": "select",
"default": "TS2",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "TS2",
"features": [],
"scope": [
"system"
],
"help_text": "The SDE status to map to when encountering an unmapped Issue Tracker status.",
"options": [
{
"label": "Complete",
"value": "TS1",
"disabled": false
},
{
"label": "Incomplete",
"value": "TS2",
"disabled": false
},
{
"label": "Not Applicable",
"value": "TS3",
"disabled": false
},
{
"label": "Do Not Modify",
"value": "no-change",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_close_state",
"label": "Closed Issue Status",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": 256,
"required": true,
"deprecated": false,
"placeholder": "The name of a status in JIRA from a mapping above.",
"features": [],
"scope": [
"system"
],
"help_text": "The name of a status in JIRA to use when its corresponding SD Elements task is removed from the project.",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "jira_issue_type",
"label": "Issue Type",
"add_label": "",
"description": "",
"field_type": "string",
"default": "Task",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "Task",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Synchronization",
"optional": true,
"description": "Settings for synchronizing SD Elements tasks.",
"fields": [
{
"name": "conflict_policy",
"label": "Choose Authoritative Source",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "issue_tracker",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "issue_tracker",
"features": [],
"scope": [
"system"
],
"help_text": "The de facto source for the status of an SD Elements task",
"options": [
{
"label": "JIRA",
"value": "issue_tracker",
"disabled": false
},
{
"label": "SD Elements",
"value": "sde",
"disabled": false
},
{
"label": "Last Status Change",
"value": "timestamp",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "how_tos_in_scope",
"label": "Include Code Sample How-To's",
"add_label": "",
"description": "Code sample How-To's in task descriptions",
"field_type": "boolean",
"default": false,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "False",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "training_in_scope",
"label": "Include Training Content",
"add_label": "",
"description": "Include available Training Course content in task descriptions",
"field_type": "boolean",
"default": false,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "False",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Tasks Filtering",
"optional": true,
"description": "Selecting any of the below options will further filter the type of tasks to synchronize.",
"fields": [
{
"name": "sde_min_priority",
"label": "Tasks having a minimum priority",
"add_label": "",
"description": "",
"field_type": "select",
"default": 1,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "1",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "10",
"value": 10,
"disabled": false
},
{
"label": "9",
"value": 9,
"disabled": false
},
{
"label": "8",
"value": 8,
"disabled": false
},
{
"label": "7 - High",
"value": 7,
"disabled": false
},
{
"label": "6",
"value": 6,
"disabled": false
},
{
"label": "5",
"value": 5,
"disabled": false
},
{
"label": "4 - Medium",
"value": 4,
"disabled": false
},
{
"label": "3",
"value": 3,
"disabled": false
},
{
"label": "2",
"value": 2,
"disabled": false
},
{
"label": "1 - Low",
"value": 1,
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_statuses_in_scope",
"label": "Tasks with status meaning",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": "TODO",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "TODO",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Done",
"value": "DONE",
"disabled": false
},
{
"label": "Todo",
"value": "TODO",
"disabled": false
},
{
"label": "N/A",
"value": "NA",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_phases",
"label": "Limit to tasks having these phases",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Activities",
"value": "activities",
"disabled": false
},
{
"label": "Requirements",
"value": "requirements",
"disabled": false
},
{
"label": "Architecture & Design",
"value": "architecture-design",
"disabled": false
},
{
"label": "Development",
"value": "development",
"disabled": false
},
{
"label": "Deployment",
"value": "deployment",
"disabled": false
},
{
"label": "Testing",
"value": "testing",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_tags_filter",
"label": "Tasks having all of the following tags",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "tag1,tag2",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_verification_filter",
"label": "Tasks with verification status",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Filter tasks based on their verification status",
"options": [
{
"label": "No Status",
"value": "none",
"disabled": false
},
{
"label": "Partial Pass",
"value": "partial",
"disabled": false
},
{
"label": "Pass",
"value": "pass",
"disabled": false
},
{
"label": "Fail",
"value": "fail",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced Issue Tracker Options",
"optional": true,
"description": "Advanced configuration options.",
"fields": [
{
"name": "issue_tracker_title_format",
"label": "Issue Tracker Title Format",
"add_label": "",
"description": "Customize the issue titles created in the Issue Tracker by choosing one of the templates below.",
"field_type": "select",
"default": "$task_id $title",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "$task_id $title",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "T1: Task title",
"value": "$task_id $title",
"disabled": false
},
{
"label": "[Application - Project] T1: Task title",
"value": "[$application - $project] $task_id $title",
"disabled": false
},
{
"label": "[Application - Context] T1: Task title",
"value": "[$application - $context] $task_id $title",
"disabled": false
},
{
"label": "[Context] T1: Task title",
"value": "[$context] $task_id $title",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_validate_cert",
"label": "Enforce Certificate Validation",
"add_label": "",
"description": "Bypasses certificate validation if unchecked (insecure, only for testing purposes)",
"field_type": "boolean",
"default": true,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "True",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_issue_label",
"label": "Issue Labels / Tags",
"add_label": "",
"description": "",
"field_type": "string",
"default": "SD-Elements",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "SD-Elements",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_parent_issue",
"label": "Issue Tracker parent issue",
"add_label": "",
"description": "Set the parent issue to indicate that tasks from SD Elements should be imported as children of the parent issue. (The nomenclature between Issue Trackers may differ: sub-tasks, sub-issues, child tasks, etc.) Please get in touch with SD Elements support for help configuring this field.",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [
"advanced_issue_tracker"
],
"scope": [
"project"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_priority_map",
"label": "Custom Priority Mapping",
"add_label": "+ Add Priority Mapping",
"description": "Customized mapping of SD Elements numerical priorities to JIRA priorities.",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "***SD Elements Priority*** can be either a single integer or a range.",
"options": [],
"key_hint_text_mapping": {
"__default__": "SD Elements Priority"
},
"value_hint_text_mapping": {
"__default__": "JIRA Priority"
},
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_custom_fields",
"label": "Custom Field Mapping",
"add_label": "+ Add Field Mapping",
"description": "Customized fields to include when creating a task in JIRA.",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [
"advanced_issue_tracker"
],
"scope": [
"system",
"project"
],
"help_text": "***Value*** can be made up of either a hard-coded value or custom macros. Consult the section 'Advanced field support' of the user guide for a list of available values.",
"options": [],
"key_hint_text_mapping": {
"__default__": "JIRA Field"
},
"value_hint_text_mapping": {
"__default__": "Value"
},
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_context",
"label": "Issue Tracker context",
"add_label": "",
"description": "Bind like projects together by providing meta information below. Set a value here if the connection has been configured to create custom issue titles containing 'Context'.",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [
"advanced_issue_tracker"
],
"scope": [
"project"
],
"help_text": "Bind a set of tasks using a certain value. This is applicable only when custom titles are selected having the entry 'Context'",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
}
]
}
]
}
Get a Specific Issue Tracker Plugin
This endpoint retrieves a specific Issue Tracker Integration Plugin resource, as specified by the id parameter.
GET /api/v2/plugins/issue-tracker/{issue_tracker_id}/
URL Parameters
| Parameter | Description |
|---|---|
| issue_tracker_id | The id of the Issue Tracker plugin to retrieve |
GET /api/v2/plugins/issue-tracker/pt/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "pt",
"name": "Pivotal Tracker",
"short_name": "Pivotal Tracker",
"command": "sync_pt",
"sections": [
{
"label": null,
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_project",
"label": "Pivotal Tracker Project",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": 255,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"project"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Connection Details",
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_method",
"label": "Protocol",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "https",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "https",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "https",
"value": "https",
"disabled": false
},
{
"label": "http",
"value": "http",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_server",
"label": "Server",
"add_label": "",
"description": "",
"field_type": "string",
"default": "www.pivotaltracker.com",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "bugs.server.com",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_context_root",
"label": "Context Root",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "/",
"features": [],
"scope": [
"system"
],
"help_text": "Normally left empty unless the service is installed at a non-standard location",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Credentials",
"optional": false,
"description": null,
"fields": [
{
"name": "issue_tracker_auth_mode",
"label": "Authentication Method",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "api_token",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "api_token",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "API Token",
"value": "api_token",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": true,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_api_token",
"label": "Pivotal Tracker Token",
"add_label": "",
"description": "",
"field_type": "masked_string",
"default": null,
"readonly": false,
"max_length": 1024,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "API Token generated within the Pivotal Tracker user profile page.",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {
"issue_tracker_auth_mode": "api_token"
},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Client Side Certificate",
"optional": true,
"description": "Settings for using a client side certificate during synchronization.",
"fields": [
{
"name": "issue_tracker_client_certificate",
"label": "Client Certificate",
"add_label": "",
"description": "A PEM encoded X509 certificate to be used by SD Elements as the client certificate.",
"field_type": "file_upload_text_field",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "Browse...",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_client_key",
"label": "Private Key",
"add_label": "",
"description": "A PEM encoded private key for the certificate. Key sizes up to 2048 bits are supported. This key will be transferred and stored securely. Once set, it cannot be viewed again.",
"field_type": "file_upload_text_field",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "Browse...",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": true,
"field_metadata": {}
},
{
"name": "issue_tracker_encryption_password",
"label": "Private Key Password",
"add_label": "",
"description": "If the private key is encrypted, specify the decryption password here. This value will only be used once to decrypt the key and will not be stored.",
"field_type": "masked_string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {
"issue_tracker_client_key__isdirty": true,
"issue_tracker_client_key__isempty": false
},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Tasks to Synchronize",
"optional": false,
"description": null,
"fields": [
{
"name": "task_filter",
"label": "Type",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "risk_policy",
"readonly": false,
"max_length": null,
"required": true,
"deprecated": false,
"placeholder": "risk_policy",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Sync all tasks",
"value": "all_tasks",
"disabled": false
},
{
"label": "Sync Risk Policy tasks",
"value": "risk_policy",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced Pivotal Tracker Configuration",
"optional": false,
"description": "Define how a Pivotal Tracker status relates to an SD Elements status and vice-versa. For example, the 'Pivotal Tracker-Done' status can map to the 'SD Elements-Complete' status. This helps clarify how your Pivotal Tracker workflow is reflected in SD Elements.",
"fields": [
{
"name": "pt_story_type",
"label": "Story Type",
"add_label": "",
"description": "",
"field_type": "string",
"default": "bug",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "bug",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_to_issue_tracker_status_mapping",
"label": "Map an SD Elements status to a Pivotal Tracker status",
"add_label": "+ Add Status Mapping",
"description": "",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Ensure that the ‘Incomplete’, ‘Complete’, and ‘Not Applicable’ statuses in SD Elements are mapped to related statuses in Pivotal Tracker. Any unmapped custom statuses will use these mappings based on their meaning.",
"options": [],
"key_hint_text_mapping": {
"__default__": "SD Elements Status"
},
"value_hint_text_mapping": {
"TS1": "ex. Done",
"TS2": "ex. Open",
"TS3": "ex. N/A or similar",
"__default__": "Pivotal Tracker Status"
},
"autocomplete": true,
"key_options": [
{
"label": "Complete",
"value": "TS1",
"disabled": false
},
{
"label": "Incomplete",
"value": "TS2",
"disabled": false
},
{
"label": "Not Applicable",
"value": "TS3",
"disabled": false
}
],
"value_options": null,
"default_key_value_mapping": [
[
"TS1",
""
],
[
"TS2",
""
],
[
"TS3",
""
]
],
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_to_sde_status_mapping",
"label": "Map a Pivotal Tracker status to an SD Elements status",
"add_label": "+ Add Status Mapping",
"description": "",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": true,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Map a Pivotal Tracker status for all required statuses in SD Elements ('Incomplete', ‘Complete’, and ‘Not Applicable’) before adding any new mappings. Any Pivotal Tracker status that is not mapped here will map to an SD Elements ‘Incomplete' status by default.",
"options": [],
"key_hint_text_mapping": {
"TS1": "ex. Done",
"TS2": "ex. Open",
"TS3": "ex. N/A or similar",
"__default__": "Pivotal Tracker Status"
},
"value_hint_text_mapping": {
"__default__": "SD Elements Status"
},
"autocomplete": true,
"key_options": null,
"value_options": [
{
"label": "Complete",
"value": "TS1",
"disabled": false
},
{
"label": "Incomplete",
"value": "TS2",
"disabled": false
},
{
"label": "Not Applicable",
"value": "TS3",
"disabled": false
}
],
"default_key_value_mapping": [
[
"",
"TS1"
],
[
"",
"TS2"
],
[
"",
"TS3"
]
],
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_fallback_state",
"label": "Unmapped Status Fallback",
"add_label": "",
"description": "",
"field_type": "select",
"default": "TS2",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "TS2",
"features": [],
"scope": [
"system"
],
"help_text": "The SDE status to map to when encountering an unmapped Issue Tracker status.",
"options": [
{
"label": "Complete",
"value": "TS1",
"disabled": false
},
{
"label": "Incomplete",
"value": "TS2",
"disabled": false
},
{
"label": "Not Applicable",
"value": "TS3",
"disabled": false
},
{
"label": "Do Not Modify",
"value": "no-change",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_close_state",
"label": "Closed Issue Status",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": 256,
"required": true,
"deprecated": false,
"placeholder": "The name of a status in Pivotal Tracker from a mapping above.",
"features": [],
"scope": [
"system"
],
"help_text": "The name of a status in Pivotal Tracker to use when its corresponding SD Elements task is removed from the project.",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "pt_group_label",
"label": "Pivotal Tracker label for stories generated by SD Elements",
"add_label": "",
"description": "",
"field_type": "string",
"default": "SD Elements",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "SD Elements",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Synchronization",
"optional": true,
"description": "Settings for synchronizing SD Elements tasks.",
"fields": [
{
"name": "conflict_policy",
"label": "Choose Authoritative Source",
"add_label": "",
"description": "",
"field_type": "radio",
"default": "issue_tracker",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "issue_tracker",
"features": [],
"scope": [
"system"
],
"help_text": "The de facto source for the status of an SD Elements task",
"options": [
{
"label": "Pivotal Tracker",
"value": "issue_tracker",
"disabled": false
},
{
"label": "SD Elements",
"value": "sde",
"disabled": false
},
{
"label": "Last Status Change",
"value": "timestamp",
"disabled": true
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "how_tos_in_scope",
"label": "Include Code Sample How-To's",
"add_label": "",
"description": "Code sample How-To's in task descriptions",
"field_type": "boolean",
"default": false,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "False",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "training_in_scope",
"label": "Include Training Content",
"add_label": "",
"description": "Include available Training Course content in task descriptions",
"field_type": "boolean",
"default": false,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "False",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Tasks Filtering",
"optional": true,
"description": "Selecting any of the below options will further filter the type of tasks to synchronize.",
"fields": [
{
"name": "sde_min_priority",
"label": "Tasks having a minimum priority",
"add_label": "",
"description": "",
"field_type": "select",
"default": 1,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "1",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "10",
"value": 10,
"disabled": false
},
{
"label": "9",
"value": 9,
"disabled": false
},
{
"label": "8",
"value": 8,
"disabled": false
},
{
"label": "7 - High",
"value": 7,
"disabled": false
},
{
"label": "6",
"value": 6,
"disabled": false
},
{
"label": "5",
"value": 5,
"disabled": false
},
{
"label": "4 - Medium",
"value": 4,
"disabled": false
},
{
"label": "3",
"value": 3,
"disabled": false
},
{
"label": "2",
"value": 2,
"disabled": false
},
{
"label": "1 - Low",
"value": 1,
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_statuses_in_scope",
"label": "Tasks with status meaning",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": "TODO",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "TODO",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Done",
"value": "DONE",
"disabled": false
},
{
"label": "Todo",
"value": "TODO",
"disabled": false
},
{
"label": "N/A",
"value": "NA",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_phases",
"label": "Limit to tasks having these phases",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "Activities",
"value": "activities",
"disabled": false
},
{
"label": "Requirements",
"value": "requirements",
"disabled": false
},
{
"label": "Architecture & Design",
"value": "architecture-design",
"disabled": false
},
{
"label": "Development",
"value": "development",
"disabled": false
},
{
"label": "Deployment",
"value": "deployment",
"disabled": false
},
{
"label": "Testing",
"value": "testing",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_tags_filter",
"label": "Tasks having all of the following tags",
"add_label": "",
"description": "",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "tag1,tag2",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "sde_verification_filter",
"label": "Tasks with verification status",
"add_label": "",
"description": "",
"field_type": "checkbox",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "Filter tasks based on their verification status",
"options": [
{
"label": "No Status",
"value": "none",
"disabled": false
},
{
"label": "Partial Pass",
"value": "partial",
"disabled": false
},
{
"label": "Pass",
"value": "pass",
"disabled": false
},
{
"label": "Fail",
"value": "fail",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced Issue Tracker Options",
"optional": true,
"description": "Advanced configuration options.",
"fields": [
{
"name": "issue_tracker_title_format",
"label": "Issue Tracker Title Format",
"add_label": "",
"description": "Customize the issue titles created in the Issue Tracker by choosing one of the templates below.",
"field_type": "select",
"default": "$task_id $title",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "$task_id $title",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [
{
"label": "T1: Task title",
"value": "$task_id $title",
"disabled": false
},
{
"label": "[Application - Project] T1: Task title",
"value": "[$application - $project] $task_id $title",
"disabled": false
},
{
"label": "[Application - Context] T1: Task title",
"value": "[$application - $context] $task_id $title",
"disabled": false
},
{
"label": "[Context] T1: Task title",
"value": "[$context] $task_id $title",
"disabled": false
}
],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_validate_cert",
"label": "Enforce Certificate Validation",
"add_label": "",
"description": "Bypasses certificate validation if unchecked (insecure, only for testing purposes)",
"field_type": "boolean",
"default": true,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "True",
"features": [],
"scope": [
"system"
],
"help_text": "",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_priority_map",
"label": "Custom Priority Mapping",
"add_label": "+ Add Priority Mapping",
"description": "Customized mapping of SD Elements numerical priorities to Pivotal Tracker priorities.",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [],
"scope": [
"system"
],
"help_text": "***SD Elements Priority*** can be either a single integer or a range.",
"options": [],
"key_hint_text_mapping": {
"__default__": "SD Elements Priority"
},
"value_hint_text_mapping": {
"__default__": "Pivotal Tracker Priority"
},
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_custom_fields",
"label": "Custom Field Mapping",
"add_label": "+ Add Field Mapping",
"description": "Customized fields to include when creating a task in Pivotal Tracker.",
"field_type": "json",
"default": null,
"readonly": false,
"max_length": 1024,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [
"advanced_issue_tracker"
],
"scope": [
"system",
"project"
],
"help_text": "***Value*** can be made up of either a hard-coded value or custom macros. Consult the section 'Advanced field support' of the user guide for a list of available values.",
"options": [],
"key_hint_text_mapping": {
"__default__": "Pivotal Tracker Field"
},
"value_hint_text_mapping": {
"__default__": "Value"
},
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "issue_tracker_context",
"label": "Issue Tracker context",
"add_label": "",
"description": "Bind like projects together by providing meta information below. Set a value here if the connection has been configured to create custom issue titles containing 'Context'.",
"field_type": "string",
"default": null,
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": null,
"features": [
"advanced_issue_tracker"
],
"scope": [
"project"
],
"help_text": "Bind a set of tasks using a certain value. This is applicable only when custom titles are selected having the entry 'Context'",
"options": [],
"key_hint_text_mapping": null,
"value_hint_text_mapping": null,
"autocomplete": false,
"key_options": null,
"value_options": null,
"default_key_value_mapping": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
}
]
}