ALM Plugins
Get all ALM Plugins
This endpoint retrieves a list of ALM Integration Plugin resources.
GET /api/v2/plugins/alm/ 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": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Connection Details",
"optional": false,
"description": null,
"fields": [
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Credentials",
"optional": false,
"description": null,
"fields": [
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": true,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {
"alm_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": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": true,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {
"alm_client_key__isempty": false,
"alm_client_key__isdirty": true
},
"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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced GitHub Configuration",
"optional": true,
"description": "Provide guidance for what issue type to use in GitHub as well as its workflow.",
"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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "alm",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "alm",
"features": [],
"scope": [
"system"
],
"help_text": "The de facto source for the status of an SD Elements task",
"options": [
{
"label": "GitHub",
"value": "alm",
"disabled": false
},
{
"label": "SD Elements",
"value": "sde",
"disabled": false
},
{
"label": "Last Status Change",
"value": "timestamp",
"disabled": true
}
],
"key_hint_text": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced ALM Options",
"optional": true,
"description": "Advanced configuration options.",
"fields": [
{
"name": "alm_title_format",
"label": "ALM Title Format",
"add_label": "",
"description": "Customize the issue titles created in the ALM 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_context",
"label": "Alm 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_alm"
],
"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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
}
]
}
]
}
Get a Specific ALM Plugin
This endpoint retrieves a specific ALM Integration Plugin resource, as specified by the id parameter.
GET /api/v2/plugins/alm/{alm_id}/
URL Parameters
| Parameter | Description |
|---|---|
| alm_id | The id of the alm plugin to retrieve |
GET /api/v2/plugins/alm/github/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "github",
"name": "GitHub",
"short_name": "GitHub",
"command": "sync_github",
"sections": [
{
"label": null,
"optional": false,
"description": null,
"fields": [
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Connection Details",
"optional": false,
"description": null,
"fields": [
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Credentials",
"optional": false,
"description": null,
"fields": [
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": true,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {
"alm_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": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": true,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {
"alm_client_key__isempty": false,
"alm_client_key__isdirty": true
},
"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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced GitHub Configuration",
"optional": true,
"description": "Provide guidance for what issue type to use in GitHub as well as its workflow.",
"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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "alm",
"readonly": false,
"max_length": null,
"required": false,
"deprecated": false,
"placeholder": "alm",
"features": [],
"scope": [
"system"
],
"help_text": "The de facto source for the status of an SD Elements task",
"options": [
{
"label": "GitHub",
"value": "alm",
"disabled": false
},
{
"label": "SD Elements",
"value": "sde",
"disabled": false
},
{
"label": "Last Status Change",
"value": "timestamp",
"disabled": true
}
],
"key_hint_text": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
},
{
"label": "Advanced ALM Options",
"optional": true,
"description": "Advanced configuration options.",
"fields": [
{
"name": "alm_title_format",
"label": "ALM Title Format",
"add_label": "",
"description": "Customize the issue titles created in the ALM 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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
},
{
"name": "alm_context",
"label": "Alm 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_alm"
],
"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": "",
"value_hint_text": "",
"autocomplete": false,
"key_options": null,
"value_options": null,
"conditions": {},
"hidden": false,
"protected": false,
"field_metadata": {}
}
]
}
]
}