deleteActivities
Delete activities from requirement
deleteActivities(
input: DeleteActivitiesInput!
): DeleteActivitiesPayload
Arguments
deleteActivities.input ● DeleteActivitiesInput! non-null input
Parameters for DeleteActivities
Type
DeleteActivitiesPayload object
Autogenerated return type of DeleteActivities.
Example request
This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.
Before you run it
Run the requirements query first and use data.requirements.collection[].id as requirementId.
- cURL
- JavaScript
- Python
curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"mutation MutateDeleteActivities($input: DeleteActivitiesInput!) {\n deleteActivities(input: $input) { activities { id label actionPlan } clientMutationId }\n}","variables":{"input":{"requirementId":"<requirement_id>","activitiesIds":["example-id"]}}}'
const response = await fetch('https://api.convisoappsec.com/graphql', {
method: 'POST',
headers: {
'content-type': 'application/json',
'x-api-key': process.env.CONVISO_API_KEY,
},
body: JSON.stringify({
query: "mutation MutateDeleteActivities($input: DeleteActivitiesInput!) {\n deleteActivities(input: $input) { activities { id label actionPlan } clientMutationId }\n}",
variables: {
"input": {
"requirementId": "<requirement_id>",
"activitiesIds": [
"example-id"
]
}
},
}),
});
const { data, errors } = await response.json();
if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);
import json
import os
import requests
response = requests.post(
'https://api.convisoappsec.com/graphql',
headers={
'content-type': 'application/json',
'x-api-key': os.environ['CONVISO_API_KEY'],
},
json={
'query': "mutation MutateDeleteActivities($input: DeleteActivitiesInput!) {\n deleteActivities(input: $input) { activities { id label actionPlan } clientMutationId }\n}",
'variables': json.loads("{\"input\":{\"requirementId\":\"<requirement_id>\",\"activitiesIds\":[\"example-id\"]}}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Contribute to the Docs
Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.
How to contribute