Skip to content

Commit 22c58b9

Browse files
Updated the APIs
1 parent 7964dd0 commit 22c58b9

File tree

2 files changed

+49
-7
lines changed

2 files changed

+49
-7
lines changed

src/content/docs/workflow-automation/workflow-automation-apis/delete-workflow-definition.mdx

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This API deletes all the workflow definition versions with the specified name.
1616
- All running workflow runs will continue to completion even if the definition is deleted.
1717
</Callout>
1818

19-
## Parameters
19+
## Input parameters
2020

2121
<table>
2222
<thead>
@@ -49,7 +49,7 @@ This API deletes all the workflow definition versions with the specified name.
4949
</tbody>
5050
</table>
5151

52-
## Example
52+
## Sample request
5353

5454
```graphql
5555
mutation {
@@ -64,8 +64,50 @@ This API deletes all the workflow definition versions with the specified name.
6464
}
6565
```
6666

67-
## Response
67+
## Sample response
6868

6969
The mutation returns:
7070

71-
- `definition.name`: The name of the deleted workflow definition.
71+
```graphql
72+
{
73+
"data": {
74+
"workflowAutomationDeleteWorkflowDefinition": null
75+
},
76+
"extensions": {
77+
"nrOnly": {
78+
"_docs": "https://pages.datanerd.us/unified-api/nerdgraph-documentation/querying/debugging/",
79+
"httpRequestLog": [
80+
{
81+
"body": "{\"query\":\"mutation {\\n deleteWorkflowDefinition(definition: { name: \\\"my-workflow\\\" }, scope: { id: \\\"12345678\\\", type: ACCOUNT }) {\\n __typename\\n definition {\\n __typename\\n name\\n }\\n }\\n}\",\"extensions\":{\"authorizedAccountIds\":{\"error\":\"Failed to fetch Authorized Account Ids.\",\"value\":null,\"success\":false}},\"variables\":{}}",
82+
"curl": "echo eyJxdWVyeSI6Im11dGF0aW9uIHtcbiAgZGVsZXRlV29ya2Zsb3dEZWZpbml0aW9uKGRlZmluaXRpb246IHsgbmFtZTogXCJteS13b3JrZmxvd1wiIH0sIHNjb3BlOiB7IGlkOiBcIjEyMzQ1Njc4XCIsIHR5cGU6IEFDQ09VTlQgfSkge1xuICAgIF9fdHlwZW5hbWVcbiAgICBkZWZpbml0aW9uIHtcbiAgICAgIF9fdHlwZW5hbWVcbiAgICAgIG5hbWVcbiAgICB9XG4gIH1cbn0iLCJleHRlbnNpb25zIjp7ImF1dGhvcml6ZWRBY2NvdW50SWRzIjp7ImVycm9yIjoiRmFpbGVkIHRvIGZldGNoIEF1dGhvcml6ZWQgQWNjb3VudCBJZHMuIiwidmFsdWUiOm51bGwsInN1Y2Nlc3MiOmZhbHNlfX0sInZhcmlhYmxlcyI6e319 | base64 -D | curl -i -X POST 'https://ng-workflow-service.service.nr-ops.net/graphql' -H 'Content-Type: application/json' -H 'X-Login-Context: access-token:SEpwU3FWbVJDeHN6bzgxdmJuVEJXaVcvcTlFY2VpdGNCZE1lMkVMdm5XeHo4dWVzYkZFQ0x3NE5vTjNVckFKSzFVSWphK2NncFpNb3dIcFFGZEFjK2REaG1pa2J4Tml1ZExMOC9IcytPN2hQRytLMlFyNSszQWZBdXVrTEhpM1dBejRmbzI3VWphcE9WVnE4YTRSbHYzVnNpMXl3bE1xc1BFVmZSZG1pWEtnNHBGbTAyTjV0TDYwVVU3dkkwZWtVSkhxS2duUVB0NTlkNzhycjlDQTNodWNmRWlBNVJjQStpdWZWWEc4SDRNRnM5cFY5Zzh1OWI2R3RRSDhWbHZVaVY5NTUvRFRVZGV0dE1tME5xWEJka0dmNU1GUUk2eWdueFljS1I5VkJJMHVnS08xZmJ6ajFySVV3MExWU243d21CbEZNbm9nd3BTMDVFWGJTMTV2UVBrck40VGhDbnVMODJJem8vTXYvdERFVXUzQ0UwK0tKTldkNThIaEdLZCtqVmQ1Z3BxUDFteTM5TFB3RHc4dGRSbXNGbjNYSDdhNlYrV0V0elRpYU8wMEZtem01R0hMaVAxd1AwOUJMSnFoU3RhZVRUS2ZvcnlCVzl4L09OTFNjN1BzeGtlVUhvT2ZhVEY2M2RNdi9GcTBoOElOai9TeUlYZm5jUlpKRUtlK0REV3dZSXY3VVdxSFhVejl4MmZLNFdvRGhuYTdIZXNDNEZBR3JTRnVDVVkySVI4ZFY0azc5dTVIL0NIV2ZGa0VLZVdJK2ZIb2VYcUxDNE85b1FDWitsdXl1RjFOUnFXS2I4WlVudHVGN3BVTDRUSVBsbXFNWjJYUUpwREVENUx5VW5hTldUeHQ3NGZVekxLRXp6QktKVGpLdHRDaHg4aVAzTC8yZGtMQlNVd2M9' -H 'newrelic-originating-region-id: 1' -d @-"
83+
},
84+
{
85+
"body": "{\"query\":\"query($capabilities: [String!]!, $scopeType: ScopeType!) {\\n actor {\\n capabilities(filter: {names: $capabilities}, scopeType: $scopeType) {\\n name\\n }\\n }\\n}\\n\",\"variables\":{\"capabilities\":[\"internal.read.nerd_graph_debug_data\"],\"scopeType\":\"GLOBAL\"}}",
86+
"curl": "echo eyJxdWVyeSI6InF1ZXJ5KCRjYXBhYmlsaXRpZXM6IFtTdHJpbmchXSEsICRzY29wZVR5cGU6IFNjb3BlVHlwZSEpIHtcbiAgYWN0b3Ige1xuICAgIGNhcGFiaWxpdGllcyhmaWx0ZXI6IHtuYW1lczogJGNhcGFiaWxpdGllc30sIHNjb3BlVHlwZTogJHNjb3BlVHlwZSkge1xuICAgICAgbmFtZVxuICAgIH1cbiAgfVxufVxuIiwidmFyaWFibGVzIjp7ImNhcGFiaWxpdGllcyI6WyJpbnRlcm5hbC5yZWFkLm5lcmRfZ3JhcGhfZGVidWdfZGF0YSJdLCJzY29wZVR5cGUiOiJHTE9CQUwifX0= | base64 -D | curl -i -X POST 'https://ng-authorization-service.service.nr-ops.net/graphql' -H 'Content-Type: application/json' -H 'X-Login-Context: access-token:SEpwU3FWbVJDeHN6bzgxdmJuVEJXaVcvcTlFY2VpdGNCZE1lMkVMdm5XeHo4dWVzYkZFQ0x3NE5vTjNVckFKSzFVSWphK2NncFpNb3dIcFFGZEFjK2REaG1pa2J4Tml1ZExMOC9IcytPN2hQRytLMlFyNSszQWZBdXVrTEhpM1dBejRmbzI3VWphcE9WVnE4YTRSbHYzVnNpMXl3bE1xc1BFVmZSZG1pWEtnNHBGbTAyTjV0TDYwVVU3dkkwZWtVSkhxS2duUVB0NTlkNzhycjlDQTNodWNmRWlBNVJjQStpdWZWWEc4SDRNRnM5cFY5Zzh1OWI2R3RRSDhWbHZVaVY5NTUvRFRVZGV0dE1tME5xWEJka0dmNU1GUUk2eWdueFljS1I5VkJJMHVnS08xZmJ6ajFySVV3MExWU243d21CbEZNbm9nd3BTMDVFWGJTMTV2UVBrck40VGhDbnVMODJJem8vTXYvdERFVXUzQ0UwK0tKTldkNThIaEdLZCtqVmQ1Z3BxUDFteTM5TFB3RHc4dGRSbXNGbjNYSDdhNlYrV0V0elRpYU8wMEZtem01R0hMaVAxd1AwOUJMSnFoU3RhZVRUS2ZvcnlCVzl4L09OTFNjN1BzeGtlVUhvT2ZhVEY2M2RNdi9GcTBoOElOai9TeUlYZm5jUlpKRUtlK0REV3dZSXY3VVdxSFhVejl4MmZLNFdvRGhuYTdIZXNDNEZBR3JTRnVDVVkySVI4ZFY0azc5dTVIL0NIV2ZGa0VLZVdJK2ZIb2VYcUxDNE85b1FDWitsdXl1RjFOUnFXS2I4WlVudHVGN3BVTDRUSVBsbXFNWjJYUUpwREVENUx5VW5hTldUeHQ3NGZVekxLRXp6QktKVGpLdHRDaHg4aVAzTC8yZGtMQlNVd2M9' -d @-"
87+
}
88+
]
89+
}
90+
},
91+
"errors": [
92+
{
93+
"message": "User is not authorized.",
94+
"path": [
95+
"workflowAutomationDeleteWorkflowDefinition"
96+
],
97+
"extensions": {
98+
"classification": "DataFetchingException",
99+
"errorClass": "ACCESS_DENIED",
100+
"nrOnly": {
101+
"owningTeam": "#help-nomad"
102+
}
103+
},
104+
"locations": [
105+
{
106+
"line": 2,
107+
"column": 3
108+
}
109+
]
110+
}
111+
]
112+
}
113+
```

src/content/docs/workflow-automation/workflow-automation-apis/get-action-definitions.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ freshnessValidatedDate: never
1111

1212
Returns all action definitions that can be used to compose a workflow definition.
1313

14-
## Parameters
14+
## Input parameters
1515

1616
<table>
1717
<thead>
@@ -32,7 +32,7 @@ Returns all action definitions that can be used to compose a workflow definition
3232
</tbody>
3333
</table>
3434

35-
## Example
35+
## Sample request
3636

3737
```graphql
3838
{
@@ -63,7 +63,7 @@ Returns all action definitions that can be used to compose a workflow definition
6363
}
6464
```
6565

66-
## Response
66+
## Sample response
6767

6868
The query returns:
6969

0 commit comments

Comments
 (0)