Parameter | Type | Explanation | Example value |
---|---|---|---|
Post issues* | BODY | Develop issues data in json |
|
Request
cURL -X POST \ https://peer-core.gravitant.net/dash/api/develop/v3/technical-services/issues \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "assignees": [ "Developer" ], "category": "bug", "created_at": "2022-10-27T07:20:50.52Z", "created_by": "Tester", "endpoint_hostname": "https://github.kyndryl.net", "endpoint_technical_service_id": "tech_id1", "issue_engine": "GitHub", "labels": [ "DI3.0_defect" ], "priority": "high", "provider_engine": "GitHub", "href": "https://dash-gravitant.net/dash/api/develop/v3/issues", "provider_href": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/issues/1233", "provider_id": "023456789", "provider_url_key": "1233", "severity": "sev3", "state": "open", "technical_service": "testing2", "technical_service_override": true, "technical_service_tag": { "GITHUB-NAMES": "DI/hq", "GITHUB-ORG-ID": "93210", "GITHUB-ORG-NAME": "DI", "GITHUB-REPO-ID": "30112", "GITHUB-REPO-NAME": "hq", "GITHUB-IDS": "93210/30112" }, "milestone_due_date": "2022-11-27T07:20:50.52Z", "milestone_name": "temp_milestone", "title": "Posted data from swagger", "updated_at": "2022-10-22T07:20:50.52Z" }'
Response 200
{ "id": "636cd4e9f7db1c65132a4ad2", "entityID": "636cd4e9f7db1c65132a4ad2" }
Field | Data type | Explanation | Example value |
---|---|---|---|
provider_id* | string | Object ID | 023456789 |
provider_href* | string | Endpoint url | https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/issues/1230 |
endpoint_technical_service_id* | string | Endpoint technical service ID | tech_service_id |
endpoint_hostname | string | Endpoint host name | https://github.kyndryl.net |
provider_engine* | string | Provider engine name | GitHub |
provider_url_key | string | Provider url ID | 1230 |
category* | string | The develop category | Bug |
created_at* | string | Date and time of issue | 2020-11-27T07:20:50.52Z |
state | string | State of the issue | Open |
assignees | []string | For whom issue is assigned | Developer |
technical_service* | string | Technical service name is an abstraction for issue group | testing2 |
technical_service_override | boolean | Override flag for the service | true |
Parameter | Type | Explanation | Example value |
Post pull requests* | BODY | Develop pull requests data in json |
|
Request
cURL -X POST \ https://peer-core.gravitant.net/dash/api/develop/v3/technical-services/pullrequests \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "created_at": "2022-10-18T07:20:50.52Z", "created_by": "Developer", "endpoint_hostname": "https://github.kyndryl.net", "endpoint_technical_service_id": "mytest", "href": "https://dash.gravitant.net/dash/api/develop/v3/pullrequests", "pr_engine": "GitLab", "provider_engine": "GitLab", "provider_href": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/test", "pull_number": 3001, "state": "closed", "title": "This for BYOD testing for test", "technical_service": "MCMP-DevOps-Intelligence/test", "technical_service_tag": { "GITHUB-NAMES": "MCMP-DevOps-Intelligence/test", "GITHUB-ORG-ID": "93210", "GITHUB-ORG-NAME": "MCMP-DevOps-Intelligence", "GITHUB-REPO-ID": "30000", "GITHUB-REPO-NAME": "test", "GITHUB-IDS": "93210/30000" }, "updated_at": "2022-10-19T07:20:50.52Z", "technical_service_override": true }
Response 200
{ "id": "636cd4e9f7db1c65132a4ad2", "entityID": "636cd4e9f7db1c65132a4ad2" }
Field | Data type | Explanation | Example value |
---|---|---|---|
provider_id* | string | Object ID | 30110 |
technical_service* | string | Technical service name is an abstraction for develop pull request group | DI/hq |
provider_href* | string | Endpoint url | https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/4001 |
endpoint_technical_service_id* | string | Endpoint technical service ID | 12345678 |
endpoint_hostname | string | Endpoint host name | https://github.kyndryl.net |
created_at* | string | Date and time of pull request | 2022-10-18T07:20:50.52Z |
state | string | State of the pull request | open |
pr_engine* | string | Pull request engine name | GitHub |
pull_number | string | Pull request number | 4001 |
technical_service_override | boolean | Override flag for the service | false |
Parameter | Type | Explanation | Example value |
Post commits* | BODY | Develop commits data in json |
|
Request
cURL -X POST \ https://peer-core.gravitant.net/dash/api/develop/v3/technical-services/commits \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "created_at": "2022-10-18T07:20:50.52Z", "created_by": "Developer", "endpoint_hostname": "https://github.kyndryl.net", "provider_id": "301103", "endpoint_technical_service_id": "mytest", "href": "https://dash.gravitant.net/dash/api/develop/v3/pullrequests", "scm_engine": "GitHu", "provider_engine": "GitHub", "provider_href": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/84e1ad6", "commit_url": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/84e1ad6", "technical_service": "MCMP-DevOps-Intelligence/hq", "technical_service_tag": { "GITHUB-NAMES": "MCMP-DevOps-Intelligence/hq", "GITHUB-ORG-ID": "93210", "GITHUB-ORG-NAME": "MCMP-DevOps-Intelligence", "GITHUB-REPO-ID": "30110", "GITHUB-REPO-NAME": "hq", "GITHUB-IDS": "93210/30110" }, "technical_service_override": true }'
Response 200
{ "id": "636cd4e9f7db1c65132a4ad2", "entityID": "636cd4e9f7db1c65132a4ad2" }
Field | Data type | Explanation | Example value |
---|---|---|---|
provider_id* | string | Object ID | 301103 |
technical_service* | string | Technical service name is an abstraction for develop commit group | MCMP-DevOps-Intelligence/hq |
provider_href* | string | Endpoint url | https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/84e1ad6 |
endpoint_technical_service_id* | string | Endpoint technical service ID | mytest |
endpoint_hostname | string | Endpoint host name | https://github.kyndryl.net |
created_at* | string | Date and time of commit | 2022-10-18T07:20:50.52Z |
provider_engine* | string | Provider engine name | GitHub |
commit_url* | string | Commit endpoint url | https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/84e1ad6 |
technical_service_override | boolean | Override flag for the service | true |
Parameter | Type | Explanation | Example value |
Patch issues* | BODY | Patch issues data in json |
|
Request
cURL -X 'PATCH' \ 'dash/api/develop/v3/technical-services/issues' \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "assignees": "AlbertD", "category": "bug", "issue_engine": "GitHub", "labels": "bug", "priority": "High", "provider_url_key": "2233", "severity": "sev3", "state": "open", "technical_service": "my-org/my-repo", "title": "This is a bug", "updated_at": "2022-11-12T07:20:50.52Z" }'
Response 200
{ "id": "635b8ef2eddcd1cedd51f539", "unique_technical_service_id": "635b8ef297754f22c914142e", "provider_id": "9876543210", "technical_service": "testing2", "technical_service_id": "635b9290e3bec9cf5b61ea96", "connectionId": "", "connectionName": "", "application_relationships": [], "href": "https://malathi-byod.gravitant.net/dash/api/develop/v3/issues/1230", "service_href": "", "provider_href": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/issues/1230", "endpoint_technical_service_id": "tech_service_id", "endpoint_hostname": "https://github.kyndryl.net", "provider_engine": "GitHub", "provider_url_key": "1230", "title": "patch api testing", "priority": "low", "severity": "high", "category": "other", "created_at": "2022-10-30T07:20:50.52Z", "updated_at": "2022-11-02T07:20:50.52Z", "state": "open", "issue_engine": "GitHub", "labels": null, "issue_type": "", "description": "", "scmengine": "", "created_by": "Malathi", "assignees": [ "Malathi" ], "milestone_name": "milestone1", "milestone_due_date": "2022-11-12T07:20:50.52Z", "ismetered": true, "technical_service_tag": { "SERVICE-UNIQUE-ID": "GitHub:https://github.kyndryl.net:tech_service_id:testing2", "additionalProp1": "", "additionalProp2": "", "additionalProp3": "" }, "pr_details": null, "child_issues": null, "is_metric_applicable": false, "technical_service_override": false }
Field | Data type | Explanation | Example value |
---|---|---|---|
priority | string | Priority of the issue | high |
severity | string | Severitu of the issue | sev3 |
issue_engine* | string | issue engine name | GitHub |
provider_url_key | string | Provider url ID | 1230 |
category* | string | The develop category | Bug |
updated_at* | string | Date and time of update | 2022-11-12T07:20:50.52Z |
state | string | State of the issue | open |
assignees | []string | For whom issue is assigned | Developer |
technical_service* | string | Technical service name is an abstraction for issue group | my-org/my-repo |
title | string | Title of the issue | This is new bug |
Parameter | Type | Explanation | Example value |
Patch pullrequests* | BODY | Patch pullrequests data in json |
|
Request
cURL -X 'PATCH' \ 'dash/api/develop/v3/technical-services/pullrequests' \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "description": "Fixing the bug related to issue_1234", "merge_commit_sha": "3b2e89ee3fedc08442e2e358b91447cda69c996e", "merged_at": "2022-11-12T07:20:50.52Z", "pr_engine": "GitHub", "pull_number": 4000, "release_name": "release2022-11-16", "state": "open", "technical_service": "my-org/my-repo", "title": "This is fix for a bug", "updated_at": "2022-11-12T07:20:50.52Z" }'
Response 200
{ "id": "635137e1729632053dc37db5", "unique_technical_service_id": "6350f46997754f22c90a0886", "provider_id": "301102", "technical_service": "MCMP-DevOps-Intelligence/hq", "technical_service_id": "6350f4c0e3bec9cf5b61ea8c", "connectionId": "", "connectionName": "", "application_relationships": [], "href": "https://malathi-byod.gravitant.net/dash/api/develop/v3/pullrequests/4000", "service_href": "", "provider_href": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/4000", "endpoint_technical_service_id": "122345678", "endpoint_hostname": "https://github.kyndryl.net", "provider_engine": "GitLab", "created_at": "2022-10-18T07:20:50.52Z", "updated_at": "2022-11-02T07:20:50.52Z", "created_by": "Malathi", "pr_engine": "GitLab", "state": "open", "title": "patch api testing", "merged_at": "0001-01-01T00:00:00Z", "release_name": "release12", "description": "", "pull_number": 4002, "ismetered": true, "ischerrypick": false, "technical_service_tag": { "GITHUB-IDS": "93210/30110", "GITHUB-NAMES": "MCMP-DevOps-Intelligence/hq", "GITHUB-ORG-ID": "93210", "GITHUB-ORG-NAME": "MCMP-DevOps-Intelligence", "GITHUB-REPO-ID": "30110", "GITHUB-REPO-NAME": "hq", "SERVICE-UNIQUE-ID": "GitLab:https://github.kyndryl.net:122345678:MCMP-DevOps-Intelligence/hq" }, "technical_service_override": false }
Field | Data type | Explanation | Example value |
---|---|---|---|
merge_commit_sha | string | SHA of commit | b2e89ee3fedc08442e2e358b91447cda69c996e |
pr_engine* | string | pr engine name | GitHub |
pull_number | int | Pull request Number | 230 |
category* | string | The develop category | bug |
updated_at* | string | Date and time of update | 2022-11-12T07:20:50.52Z |
merge_at* | string | Date and time of merge | 2022-11-12T07:20:50.52Z |
state | string | State of the PR | open |
assignees | []string | For whom issue is assigned | Developer |
technical_service* | string | Technical service name is an abstraction for issue group | my-org/my-repo |
title | string | Title of the issue | This is new PR |
description | string | Description of the PR | Fixing the bug |
Parameter | Type | Explanation | Example value |
CommitID* | PATH | Commit ID is the value received after posting the commit | 2233c878609c251f44a1bbbb |
Request
cURL -X 'PATCH' \ 'dash/api/develop/v3/technical-services/commits/635b8ef2eddcd1cedd51f539' \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "comments": "Committing the fix for BYOD", "parent_ids": "3b2e89ee3fedc08442e2e" }'
Response 200
{ "id": "6357a9d8d1c04c9de360716f", "unique_technical_service_id": "6352330097754f22c90c12bf", "provider_id": "301103", "technical_service": "MCMP-DevOps-Intelligence/hq", "technical_service_id": "63523380e3bec9cf5b61ea90", "connectionId": "", "connectionName": "", "application_relationships": [], "href": "https://malathi-byod.gravitant.net/dash/api/develop/v3/Commits/84e1d4", "service_href": "", "provider_href": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/84e1ad4", "endpoint_technical_service_id": "12245678", "endpoint_hostname": "https://github.kyndryl.net", "provider_engine": "GitHub", "sha": "", "comments": "Committing the fix for BYOD", "created_at": "2022-10-18T07:20:50.52Z", "scm_engine": "GitHu", "created_by": "Malathi", "commit_url": "https://github.kyndryl.net/MCMP-DevOps-Intelligence/hq/84e1ad4", "lines_added": 0, "lines_deleted": 0, "total_lines": 0, "committer": { "committer_id": "", "name": "", "email": "" }, "parent_ids": null, "ismetered": true, "technical_service_tag": { "GITHUB-IDS": "93210/30110", "GITHUB-NAMES": "MCMP-DevOps-Intelligence/hq", "GITHUB-ORG-ID": "93210", "GITHUB-ORG-NAME": "MCMP-DevOps-Intelligence", "GITHUB-REPO-ID": "30110", "GITHUB-REPO-NAME": "hq", "SERVICE-UNIQUE-ID": "GitHu:https://github.kyndryl.net:12245678:MCMP-DevOps-Intelligence/hq" }, "technical_service_override": false }
Field | Data type | Explanation | Example value |
---|---|---|---|
comments | string | Comments about the commit | This is new commit for BYOD |
parent_ids | string | Parent ids of the commit | 6357a9d8d1c04c9de360716f |
Parameter | Type | Explanation | Example value |
Delete issues* | BODY | Delete issues data in json |
|
Request
cURL -X 'DELETE' \ 'dash/api/develop/v3/technical-services/issues' \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "endpoint_hostname": "https://github.com", "endpoint_technical_service_id": "my-org/my-repo", "provider_url_key": "4433" }'
Field | Data type | Explanation | Example value |
---|---|---|---|
endpoint_hostname | string | End point hostname | https://github.com |
endpoint_technical_service_id | string | ID of endpoint Technical serrvice | my-org/my-repo |
provider_url_key | string | Issue ID | 4433 |
Parameter | Type | Explanation | Example value |
Delete pullrequests* | BODY | Delete pullrequests data in json | { "endpoint_hostname": "https://github.com", "endpoint_technical_service_id": "my-org/my-repo", "pull_number": 1234 } |
Request
cURL -X 'DELETE' \ 'dash/api/develop/v3/technical-services/pullrequests' \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' \ -H 'Content-Type: application/json' \ -d '{ "endpoint_hostname": "https://github.com", "endpoint_technical_service_id": "my-org/my-repo", "pull_number": 1234 }'
Field | Data type | Explanation | Example value |
---|---|---|---|
endpoint_hostname | string | End point hostname | https://github.com |
endpoint_technical_service_id | string | ID of endpoint Technical serrvice | my-org/my-repo |
pull_number | int | PullRequest Number | 1234 |
Parameter | Type | Explanation | Example value |
CommitID* | PATH | Commit ID is the value received after posting the commit | 2233c878609c251f44a1bbbb |
Request
cURL -X 'DELETE' \ 'dash/api/develop/v3/technical-services/commits/636cd4e9f7db1c65132a4ad2' \ -H 'accept: application/json' \ -H 'Authorization: Token x0VqMwii93HnzfWwGI-uxJniZ8_clVZa2I02i3u2rXw2ZalmxntfOglTCqSE0uUZ' }'