Azure board Integration APIs

Azure board Integration APIs help in integrating Azure Board with Prancer at the collections level. The user can set project keys to view and create issues on the same.

Collection Configuration API.

This API is to check the existing integrations status. 

  • CURL Sample
curl -X GET 'https://portal.prancer.io/prancer-customer1/api/collection/configuration?container=<container_name' -H 'Authorization: Bearer <JWT Bearer Token>'
  • URL: https://portal.prancer.io/prancer-customer1/api/collection/configuration
  • Method: GET
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
    "container": "Container_Name",

  • Explanation: The Container field is mandatory.

  • Response:

{
    "data": {
        "azureboard": "not-integrated",
        "jira": "integrated"
    },
    "error": "",
    "error_list": [],
    "message": "Configuration data.",
    "metadata": {},
    "status": 200
}

AzureBoard Integration API.

It has two API methods POST and DELETE. POST API is to initiate the integration by getting the details from the user and DELETE API for deleting the existing Azure board integration if any. 

POST method.

API to initiate the Azure board integration - CURL Sample

curl -X POST 'https://portal.prancer.io/prancer-customer1/api/azboard/integration/' -H 'Authorization: Bearer <JWT Bearer Token>' --data-raw '{
    "url": "https://dev.azure.com/<organisationname>",
    "container":"<container_name",
    "username":"<useremail>",
    "authtoken":"<access_token>",
    "project":"<project_name",
    "severity":"high",
    "organisation":"prancer"
}'

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
{
    "container":"Container Name",
    "url" : "User’s url to connect to Azureboard",
    "username" : "Email to AzureBoard login.",
    "authtoken" : "User's API token.",
    "organisation" : "Prancer",
    "project" : "Name of the project.",
    "severity" : "Severity that has to be set."

}

  • Explanation: All of the fields are required.

  • Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Azure DevOps Board integration is sucessfull! Created a new record",
    "metadata": {},
    "status": 200
}

DELETE method.

API to delete the Azure board integration - CURL Sample

curl -X DELETE 'https://portal.prancer.io/prancer-customer1/api/azboard/integration/?container=aws_cloud_specific' -H 'Authorization: Bearer <JWT Bearer Token>'

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
    "container":"Container Name"

  • Explanation: Container field is mandatory.

  • Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Azure board configuration deleted successfully.",
    "metadata": {},
    "status": 200
}

Get Project List API.

This API is to list the projects available in the mentioned account. 

  • CURL Sample
curl -X GET 'https://portal.prancer.io/prancer-customer1/api/azboard/project/?url=https://dev.azure.com/account_name&username=<user_email>&authtoken=<token>' -H 'Authorization: Bearer <JWT Bearer Token>'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/project/
  • Method: GET
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
{   
    "url" : "https://dev.azure.com/account_name",
    "username" : "Email to Azure board login.",
    "authtoken" : "User's API token.",
}

  • Explanation: All of the fields are required.

    • url : Azure board URL of the user.
    • username : username for Azure board URL.
    • authtoken : authtoken for Azure board URL.

  • Response:

{
    "data": {
        "projects": [
            "NextGen Cloud",
            "Project B",
            "Project Red"
        ]
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}

Get State API.

This API is to list the state available for the project. 

  • CURL Sample
curl -X GET 'https://portal.prancer.io/prancer-customer1/api/azboard/workitemtype/state/?container=container_name&workitem=Issue' -H 'Authorization: Bearer <JWT Bearer Token>'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/state/
  • Method: GET
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
    "container": "Container_Name",
    "workitem" : "workitemtype"

  • Explanation: All the fields are mandatory.

  • Response:

{
    "data": {
        "state_list": [
            "To Do",
            "Doing",
            "Done"
        ]
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}

Get Workitem type API.

This API is to list the workitem types available for the user. 

  • CURL Sample
curl -X GET 'https://portal.prancer.io/prancer-customer1/api/azboard/workitemtype/?container=container_name' -H 'Authorization: Bearer <JWT Bearer Token>'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/workitemtype/
  • Method: GET
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
    container: "Container_Name"

  • Explanation: The Container field is mandatory.

  • Response:

{
    "data": {
        "workitemtype": [
            "Issue",
            "Epic",
            "Issue",
            "Test Case",
            "Shared Steps",
            "Shared Parameter",
            "Code Review Request",
            "Code Review Response",
            "Feedback Request",
            "Feedback Response",
            "Test Plan",
            "Test Suite",
            "Task",
            "Code Review Request"
        ]
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}

Get Workitem tags API.

This API is to list the workitem tags available for the user. 

  • CURL Sample
curl -X GET 'https://portal.prancer.io/prancer-customer1/api/azboard/workitem/tags/?container=container_name -H 'Authorization: Bearer <JWT Bearer Token>'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/workitem/tags/
  • Method: GET
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
    container: "Container_Name"

  • Explanation: The Container field is mandatory.

  • Response:

{
    "data": {
        "taglist": [
            "aaa",
            "bbb",
            "ccc",
            "CSPM",
            "IAC"
        ]
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}

Get Workitem field API.

This API is to list the fields available for workitem choosen. . 

  • CURL Sample
curl -X GET 'https://portal.prancer.io/prancer-customer1/api/azboard/wifield?container=<container_name>' -H 'Authorization: Bearer <JWT Bearer Token>'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/wifield
  • Method: GET
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
    "container": "Container_Name",
    "workitem" : "workitemtype"

  • Explanation: All the fields are mandatory.

  • Response:

{
    "data": {
        "workitemtype": [
            "Iteration Path",
            "Iteration ID",
            "External Link Count",
            "Iteration Level 7",
            "Iteration Level 6",
            "Iteration Level 5",
            "Iteration Level 4",
            "Iteration Level 3",
            "Iteration Level 2",
            "Iteration Level 1",
            "Area Level 7",
            "Area Level 6",
            "Area Level 5",
            "Area Level 4",
            "Area Level 3",
            "Area Level 2",
            "Area Level 1",
            "Team Project",
            "Parent",
            "Remote Link Count",
            "Comment Count",
            "Hyperlink Count",
            "Attached File Count",
            "Node Name",
            "Area Path",
            "Revised Date",
            "Changed Date",
            "ID",
            "Area ID",
            "Authorized As",
            "Title",
            "State",
            "Authorized Date",
            "Watermark",
            "Rev",
            "Changed By",
            "Reason",
            "Assigned To",
            "Work Item Type",
            "Created Date",
            "Created By",
            "Description",
            "History",
            "Related Link Count",
            "Tags",
            "Board Column",
            "Board Column Done",
            "Board Lane",
            "State Change Date",
            "Activated Date",
            "Activated By",
            "Closed Date",
            "Closed By",
            "Priority",
            "Stack Rank",
            "Effort",
            "Resolved By",
            "Resolved Date"
        ]
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}

AzureBoard Configuration API.

This API has three methods: POST, GET and PUT. This API is to collect data from user input, save and fetch when required and also can be edited. The fields are, workitem,project,fields,status and container. The detailed explanation are below: 

POST method.

This method is to post the data received. 

  • CURL Sample
curl -X POST 'https://portal.prancer.io/prancer-customer1/api/azboard/configuration/' -H 'Authorization: Bearer <JWT Bearer Token>' --data-raw '{
    "workitem": "Issue",
    "state": "To Do",
    "tags": ["prancer", "S3", "app"],
    "container":"container_name"
}'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/configuration/
  • Method: POST
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
{
    "workitem": "Issue",
    "state": "To Do",
    "tags": ["prancer", "S3", "app"],
    "container":"aws_cloud_specific"
}

  • Explanation: All of the fields are required.

    • workitem: Workitem type that the user wish to create,
    • state : State that has to be set initially,
    • container : Name of the container.
    • tags : list of tags which has to be set initially.

  • Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Azure Board configuration is added.",
    "metadata": {},
    "status": 200
}

GET method.

This API is to fetch the data, which were set by the user. 

  • CURL Sample
curl -X GET 'https://portal.prancer.io/prancer-customer1/api/azboard/configuration?container=<container_name>' -H 'Authorization: Bearer <JWT Bearer Token>'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/configuration/
  • Method: GET
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
    "container": "Container_Name",

  • Explanation: The Container field is mandatory.

  • Response:

{
    "data": {
        "configid": "63a984664b093c92185966a7",
        "container": "container_name",
        "project": "Project Name",
        "state": "To Do",
        "tags": [
            "prancer",
            "S3",
            "app"
        ],
        "url": "https://dev.azure.com/account_name",
        "workitem": "Issue"
    },
    "error": "",
    "error_list": [],
    "message": "Azureboard configuration as added.",
    "metadata": {},
    "status": 200
}

PUT method.

This method is to be able to edit the data. 

  • CURL Sample
curl -X PUT 'https://portal.prancer.io/prancer-customer1/api/azboard/configuration/' -H 'Authorization: Bearer <JWT Bearer Token>' --data-raw '{
    "workitem": "Epic",
    "state": "Doing",
    "container":"container_name",
    "tags": ["Infra", "Prancer", "IAC"]
}'
  • URL: https://portal.prancer.io/prancer-customer1/api/azboard/configuration/
  • Method: PUT
  • Header:
    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param:
{
    "workitem": "Epic",
    "state": "Doing",
    "container":"container_name",
    "tags": ["Infra", "Prancer", "IAC"]
}

  • Explanation: All other fields are required

    • workitem: Workitem type that the user wish to create.
    • tags :list of tags which has to be set initially.
    • state : State that has to be set initially.
    • container : Name of the container.

  • Response:

{
    "data": {},
    "error": "",
    "error_list": [],
    "message": "Azure board configuration is modified.",
    "metadata": {},
    "status": 200
}

AzureBoard Issues API.

This API has POST and PATCH methods.Creating a single or bulk workitems can be done with this API.

POST method

  • The POST method is to create a single workitem.

  • CURL Sample

curl -X POST 'https://portal.prancer.io/prancer-customer1/api/azboard/ticket/create/' -H 'Authorization: Bearer <JWT Bearer Token>'  --data-raw '{"container":"aws_cloud_specific", "pac_alert_ids": ["62b59d9105c659f779127df4", "62b9af0d0f8908d3969b39b6", "62b9af0d0f8908d3969b39f0"]}

- URL: https://portal.prancer.io/prancer-customer1/api/azboard/ticket/create/ - Method:POST - Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param for creating a single issue:
{
    "container":"aws_cloud_specific",
    "pac_alert_ids": [
        "62b59d9105c659f779127df4", 
        "62b9af0d0f8908d3969b39b6", 
        "62b9af0d0f8908d3969b39f0"
        ]
}

  • Explanation:

    Required Fields

    • container: Name of the cloud container for which you want want to create Jira tickets.

    For Creating Ticket for Infra findings: - result_id: Result id of the infra output. - output_id: Output id of the infra output. - test_id: Test id of the failed testcase of the infra output. - snapshot_id: Snapshot id of the failed testcase in infra output.

    For Creating Ticket for App findings: - pac_alert_ids: Alert id list for which ticket needs to be created.

    Optional Fields

    • matching_testcase: : Valid values are true and false. To create the a single ticket for all similar failed testcases on the Infra findings if true

  • Response:

{
    "data": {
        "task_link": {
            "href": "https://dev.azure.com/wildkloud/27ab1504-3280-41e1-920a-7a3685a75d6d/_workitems/edit/108"
        }
    },
    "error": "",
    "error_list": [],
    "message": "Successfully created a ticket.",
    "metadata": {},
    "status": 200
}

PATCH method-For creating bulk issues

  • CURL Sample
curl -X PATCH 'https://portal.prancer.io/prancer-customer1/api/azboard/issue' -H 'Authorization: Bearer <JWT Bearer Token>' --data-raw '{"container": "aws_tf_rds","issues": [{"title": "Bulk issue creation 3"},{"title": "Bulk issue creation 4"},{"title": "Bulk issue creation 10"},{"title": "Bulk issue creation 12 "}]}'

- URL: https://portal.prancer.io/prancer-customer1/api/azboard/issue - Method:PATCH - Header:

    - content-type: application/json
    - Authorization: Bearer <JWT Bearer Token>
  • Param for creating a multiple issues:
{
    "container": "aws_tf_rds",
    "issues": [
        {
            "title": "Bulk issue creation 3"
        },
        {
            "title": "Bulk issue creation 4"
        },
        {
            "title": "Bulk issue creation 10"
        },
        {
            "title": "Bulk issue creation 12 "
        }
    ]
}

  • Explanation: The Container and issues fields are mandatory.

  • Response:

{
    "data": {
        "results": {
            "count": 4,
            "value": [
                {
                    "body": "{\"id\":81,\"rev\":1,\"fields\":{\"System.AreaPath\":\"Project B\",\"System.TeamProject\":\"Project B\",\"System.IterationPath\":\"Project B\",\"System.WorkItemType\":\"Task\",\"System.State\":\"To Do\",\"System.Reason\":\"New task\",\"System.CreatedDate\":\"2022-11-09T11:12:44.217Z\",\"System.CreatedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.ChangedDate\":\"2022-11-09T11:12:44.217Z\",\"System.ChangedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.CommentCount\":0,\"System.Title\":\"Bulk issue creation 3\",\"Microsoft.VSTS.Common.StateChangeDate\":\"2022-11-09T11:12:44.217Z\",\"Microsoft.VSTS.Common.Priority\":2},\"_links\":{\"self\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/81\"},\"workItemUpdates\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/81/updates\"},\"workItemRevisions\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/81/revisions\"},\"workItemComments\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/81/comments\"},\"html\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_workitems/edit/81\"},\"workItemType\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_apis/wit/workItemTypes/Task\"},\"fields\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/fields\"}},\"url\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/81\"}",
                    "code": 200,
                    "headers": {
                        "Content-Type": "application/json; charset=utf-8"
                    }
                },
                {
                    "body": "{\"id\":82,\"rev\":1,\"fields\":{\"System.AreaPath\":\"Project B\",\"System.TeamProject\":\"Project B\",\"System.IterationPath\":\"Project B\",\"System.WorkItemType\":\"Task\",\"System.State\":\"To Do\",\"System.Reason\":\"New task\",\"System.CreatedDate\":\"2022-11-09T11:12:44.217Z\",\"System.CreatedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.ChangedDate\":\"2022-11-09T11:12:44.217Z\",\"System.ChangedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.CommentCount\":0,\"System.Title\":\"Bulk issue creation 4\",\"Microsoft.VSTS.Common.StateChangeDate\":\"2022-11-09T11:12:44.217Z\",\"Microsoft.VSTS.Common.Priority\":2},\"_links\":{\"self\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/82\"},\"workItemUpdates\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/82/updates\"},\"workItemRevisions\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/82/revisions\"},\"workItemComments\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/82/comments\"},\"html\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_workitems/edit/82\"},\"workItemType\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_apis/wit/workItemTypes/Task\"},\"fields\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/fields\"}},\"url\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/82\"}",
                    "code": 200,
                    "headers": {
                        "Content-Type": "application/json; charset=utf-8"
                    }
                },
                {
                    "body": "{\"id\":83,\"rev\":1,\"fields\":{\"System.AreaPath\":\"Project B\",\"System.TeamProject\":\"Project B\",\"System.IterationPath\":\"Project B\",\"System.WorkItemType\":\"Task\",\"System.State\":\"To Do\",\"System.Reason\":\"New task\",\"System.CreatedDate\":\"2022-11-09T11:12:44.217Z\",\"System.CreatedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.ChangedDate\":\"2022-11-09T11:12:44.217Z\",\"System.ChangedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.CommentCount\":0,\"System.Title\":\"Bulk issue creation 10\",\"Microsoft.VSTS.Common.StateChangeDate\":\"2022-11-09T11:12:44.217Z\",\"Microsoft.VSTS.Common.Priority\":2},\"_links\":{\"self\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/83\"},\"workItemUpdates\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/83/updates\"},\"workItemRevisions\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/83/revisions\"},\"workItemComments\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/83/comments\"},\"html\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_workitems/edit/83\"},\"workItemType\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_apis/wit/workItemTypes/Task\"},\"fields\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/fields\"}},\"url\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/83\"}",
                    "code": 200,
                    "headers": {
                        "Content-Type": "application/json; charset=utf-8"
                    }
                },
                {
                    "body": "{\"id\":84,\"rev\":1,\"fields\":{\"System.AreaPath\":\"Project B\",\"System.TeamProject\":\"Project B\",\"System.IterationPath\":\"Project B\",\"System.WorkItemType\":\"Task\",\"System.State\":\"To Do\",\"System.Reason\":\"New task\",\"System.CreatedDate\":\"2022-11-09T11:12:44.217Z\",\"System.CreatedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.ChangedDate\":\"2022-11-09T11:12:44.217Z\",\"System.ChangedBy\":\"Abinaya Mahalingam <Abinaya.Mahalingam@prancer.io>\",\"System.CommentCount\":0,\"System.Title\":\"Bulk issue creation 12 \",\"Microsoft.VSTS.Common.StateChangeDate\":\"2022-11-09T11:12:44.217Z\",\"Microsoft.VSTS.Common.Priority\":2},\"_links\":{\"self\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/84\"},\"workItemUpdates\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/84/updates\"},\"workItemRevisions\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/84/revisions\"},\"workItemComments\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/84/comments\"},\"html\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_workitems/edit/84\"},\"workItemType\":{\"href\":\"https://dev.azure.com/wildkloud/618632a1-db64-4649-ae0e-ae1524eec7a0/_apis/wit/workItemTypes/Task\"},\"fields\":{\"href\":\"https://dev.azure.com/wildkloud/_apis/wit/fields\"}},\"url\":\"https://dev.azure.com/wildkloud/_apis/wit/workItems/84\"}",
                    "code": 200,
                    "headers": {
                        "Content-Type": "application/json; charset=utf-8"
                    }
                }
            ]
        }
    },
    "error": "",
    "error_list": [],
    "message": "",
    "metadata": {},
    "status": 200
}