createRequirementActivity
Create an activity in a requirement
createRequirementActivity(
input: CreateRequirementActivityInput!
): CreateRequirementActivityPayload
Arguments
createRequirementActivity.input ● CreateRequirementActivityInput! non-null input
Parameters for CreateRequirementActivity
Type
CreateRequirementActivityPayload object
Autogenerated return type of CreateRequirementActivity.
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 MutateCreateRequirementActivity($input: CreateRequirementActivityInput!) {\n createRequirementActivity(input: $input) { activity { id label actionPlan } clientMutationId }\n}","variables":{"input":{"requirementId":"<requirement_id>","activity":{"label":"example","description":"example"}}}}'
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 MutateCreateRequirementActivity($input: CreateRequirementActivityInput!) {\n createRequirementActivity(input: $input) { activity { id label actionPlan } clientMutationId }\n}",
variables: {
"input": {
"requirementId": "<requirement_id>",
"activity": {
"label": "example",
"description": "example"
}
}
},
}),
});
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 MutateCreateRequirementActivity($input: CreateRequirementActivityInput!) {\n createRequirementActivity(input: $input) { activity { id label actionPlan } clientMutationId }\n}",
'variables': json.loads("{\"input\":{\"requirementId\":\"<requirement_id>\",\"activity\":{\"label\":\"example\",\"description\":\"example\"}}}"),
},
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