requirementSyncConfigurations
List requirement sync configurations for a scope integration
requirementSyncConfigurations(
integrationId: ID!
page: Int = 1
limit: Int
): RequirementSyncConfigurationCollection
Arguments
requirementSyncConfigurations.integrationId ● ID! non-null scalar
requirementSyncConfigurations.page ● Int scalar
requirementSyncConfigurations.limit ● Int scalar
Type
RequirementSyncConfigurationCollection object
RequirementSyncConfigurationCollection type
Example request
This generated query 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":"query GetRequirementSyncConfigurations($integrationId: ID!) {\n requirementSyncConfigurations(integrationId: $integrationId) { collection { id autoSync configEntries { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{"integrationId":"<integration_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: "query GetRequirementSyncConfigurations($integrationId: ID!) {\n requirementSyncConfigurations(integrationId: $integrationId) { collection { id autoSync configEntries { __typename } } metadata { currentPage limitValue totalCount } }\n}",
variables: {
"integrationId": "<integration_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': "query GetRequirementSyncConfigurations($integrationId: ID!) {\n requirementSyncConfigurations(integrationId: $integrationId) { collection { id autoSync configEntries { __typename } } metadata { currentPage limitValue totalCount } }\n}",
'variables': json.loads("{\"integrationId\":\"<integration_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