createRequirementSyncConfiguration
Create a requirement sync configuration for a defect tracker integration
createRequirementSyncConfiguration(
input: CreateRequirementSyncConfigurationInput!
): CreateRequirementSyncConfigurationPayload
Arguments
createRequirementSyncConfiguration.input ● CreateRequirementSyncConfigurationInput! non-null input
Parameters for CreateRequirementSyncConfiguration
Type
CreateRequirementSyncConfigurationPayload object
Autogenerated return type of CreateRequirementSyncConfiguration.
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 integrations query first and use data.integrations.collection[].id as integrationId.
- 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 MutateCreateRequirementSyncConfiguration($input: CreateRequirementSyncConfigurationInput!) {\n createRequirementSyncConfiguration(input: $input) { clientMutationId requirementSyncConfigurations { id autoSync configEntries { __typename } } }\n}","variables":{"input":{"integrationId":1,"projectIds":[1]}}}'
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 MutateCreateRequirementSyncConfiguration($input: CreateRequirementSyncConfigurationInput!) {\n createRequirementSyncConfiguration(input: $input) { clientMutationId requirementSyncConfigurations { id autoSync configEntries { __typename } } }\n}",
variables: {
"input": {
"integrationId": 1,
"projectIds": [
1
]
}
},
}),
});
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 MutateCreateRequirementSyncConfiguration($input: CreateRequirementSyncConfigurationInput!) {\n createRequirementSyncConfiguration(input: $input) { clientMutationId requirementSyncConfigurations { id autoSync configEntries { __typename } } }\n}",
'variables': json.loads("{\"input\":{\"integrationId\":1,\"projectIds\":[1]}}"),
},
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