Issue Tracker Connectors

Get All Issue Tracker Connectors

Returns a list of all Issue Tracker connectors available.

GET /api/v2/connectors/issue-tracker/

GET /api/v2/connectors/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": 1,
            "name": "GitHub Example Connector",
            "system": {
                "id": "github",
                "short_name": "GitHub",
                "name": "GitHub"
            },
            "inaccessible": false,
            "params": {
                "github_repo_owner": "repo owner",
                "sde_verification_filter": "none,partial,pass,fail",
                "issue_tracker_auth_mode": "api_token",
                "issue_tracker_api_token": "token",
                "title_format": "$task_id $title",
                "issue_tracker_method": "https",
                "issue_tracker_server": "api.github.com",
                "github_duplicate_label": "duplicate",
                "issue_tracker_phases": "requirements,architecture-design,development",
                "sde_statuses_in_scope": "TODO",
                "conflict_policy": "issue_tracker",
                "sde_min_priority": "7"
            }
        },
        {
            "id": 2,
            "name": "JIRA Example Connector",
            "system": {
                "id": "jira",
                "short_name": "JIRA",
                "name": "JIRA"
            },
            "inaccessible": false,
            "params": {
                "sde_verification_filter": "none,partial,pass,fail",
                "jira_version": "5",
                "title_format": "$task_id $title",
                "issue_tracker_method": "https",
                "issue_tracker_server": "my-company.atlassian.net",
                "issue_tracker_auth_mode": "basic",
                "issue_tracker_user": "user",
                "issue_tracker_pass": "pass",
                "issue_tracker_phases": "requirements,architecture-design,development",
                "sde_statuses_in_scope": "TODO",
                "conflict_policy": "issue_tracker",
                "sde_min_priority": "7"
            }
        }
    ]
}

Get a Specific Issue Tracker Connector

Returns a specific Issue Tracker connector.

GET /api/v2/connectors/issue-tracker/{id}/

GET /api/v2/connectors/issue-tracker/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "GitHub Example Connector",
    "system": {
        "id": "github",
        "short_name": "GitHub",
        "name": "GitHub"
    },
    "inaccessible": false,
    "params": {
        "github_repo_owner": "repo owner",
        "sde_verification_filter": "none,partial,pass,fail",
        "issue_tracker_auth_mode": "api_token",
        "issue_tracker_api_token": "token",
        "title_format": "$task_id $title",
        "issue_tracker_method": "https",
        "issue_tracker_server": "api.github.com",
        "github_duplicate_label": "duplicate",
        "issue_tracker_phases": "requirements,architecture-design,development",
        "sde_statuses_in_scope": "TODO",
        "conflict_policy": "issue_tracker",
        "sde_min_priority": "7"
    }
}

Create an Issue Tracker Connector

Fields Required Description
name Yes The name of the new connector.
system Yes A dictionary identifying the system, containing its id. For example: {"id": "github"}.
inaccessible No Specifies whether the Issue Tracker server specific is accessible from the SDE server. Defaults to false.
params Yes A dictionary containing connections options. Please refer to product documentation for more details or reach out to support. Required params will return appropriate errors when unspecified. 
POST /api/v2/connectors/issue-tracker/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name": "GitHub Example Connector",
    "system": {
        "id": "github"
    },
    "inaccessible": false,
    "params": {
        "github_repo_owner": "repo owner",
        "sde_verification_filter": "none,partial,pass,fail",
        "issue_tracker_auth_mode": "api_token",
        "issue_tracker_api_token": "token",
        "title_format": "$task_id $title",
        "issue_tracker_method": "https",
        "issue_tracker_server": "api.github.com",
        "github_duplicate_label": "duplicate",
        "issue_tracker_phases": "requirements,architecture-design,development",
        "sde_statuses_in_scope": "TODO",
        "conflict_policy": "issue_tracker",
        "sde_min_priority": "7"
    }
}

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": 1,
    "name": "GitHub Example Connector",
    "system": {
        "id": "github",
        "short_name": "GitHub",
        "name": "GitHub"
    },
    "inaccessible": false,
    "params": {
        "github_repo_owner": "repo owner",
        "sde_verification_filter": "none,partial,pass,fail",
        "issue_tracker_auth_mode": "api_token",
        "issue_tracker_api_token": "token",
        "title_format": "$task_id $title",
        "issue_tracker_method": "https",
        "issue_tracker_server": "api.github.com",
        "github_duplicate_label": "duplicate",
        "issue_tracker_phases": "requirements,architecture-design,development",
        "sde_statuses_in_scope": "TODO",
        "conflict_policy": "issue_tracker",
        "sde_min_priority": "7"
    }
}

Update an Issue Tracker Connector

Updates a specific Issue Tracker connector resource as specified by the connector id.

PATCH /api/v2/connectors/issue-tracker/{id}

PATCH /api/v2/connectors/issue-tracker/3/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name": "GitHub Connector PATCH Example",
    "system": {
        "id": "github"
    },
    "inaccessible": false,
    "params": {
        "github_repo_owner": "new repo owner",
        "sde_verification_filter": "none,partial,pass,fail",
        "issue_tracker_auth_mode": "api_token",
        "issue_tracker_api_token": "new token",
        "title_format": "$task_id $title",
        "issue_tracker_method": "https",
        "issue_tracker_server": "api.github.com",
        "github_duplicate_label": "duplicate",
        "issue_tracker_phases": "requirements,architecture-design,development",
        "sde_statuses_in_scope": "TODO",
        "conflict_policy": "issue_tracker",
        "sde_min_priority": "5"
    }
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 12,
    "name": "GitHub Connector PATCH Example",
    "system": {
        "id": "github",
        "short_name": "GitHub",
        "name": "GitHub"
    },
    "inaccessible": false,
    "params": {
        "github_repo_owner": "new repo owner",
        "sde_verification_filter": "none,partial,pass,fail",
        "issue_tracker_auth_mode": "api_token",
        "issue_tracker_api_token": "new token",
        "title_format": "$task_id $title",
        "issue_tracker_method": "https",
        "issue_tracker_server": "api.github.com",
        "github_duplicate_label": "duplicate",
        "issue_tracker_phases": "requirements,architecture-design,development",
        "sde_statuses_in_scope": "TODO",
        "conflict_policy": "issue_tracker",
        "sde_min_priority": "5"
    }
}

Delete an Issue Tracker Connector

Delete a specific Issue Tracker connector resource as specified by the connector id.

DELETE /api/v2/connectors/issue-tracker/{id}

DELETE /api/v2/connectors/issue-tracker/3/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 204 No Content
Content-Type: application/json

Test an Issue Tracker Connector

Performs a simple connectivity test against the Issue Tracker server.

POST /api/v2/connectors/test-issue-tracker/

Fields Required Description
name Yes The name of the connector.
system Yes A dictionary identifying the system, containing its id. For example: {"id": "github"}.
params Yes A dictionary containing connections options. Please refer to product documentation for more details or reach out to support. Required params will return appropriate errors when unspecified. 
POST /api/v2/connectors/test-issue-tracker/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name":"Issue Tracker Test",
    "system": {
        "id": "github"
    },
    "params": {
        "issue_tracker_server": "api.github.com",
        "github_repo_owner": "repo owner",
        "issue_tracker_auth_mode": "api_token",
        "issue_tracker_api_token": "42",
        "issue_tracker_validate_cert": true
    }
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "success": true
}

results matching ""

    No results matching ""