checkmarxExternalProjects

Gets a list of projects in Checkmarx One platform

checkmarxExternalProjects(
  companyId: ID!
  filterName: String
  pagination: PaginationInput!
): ExternalProjectCollection

Arguments

checkmarxExternalProjects.companyId ● ID! non-null scalar

checkmarxExternalProjects.filterName ● String scalar

checkmarxExternalProjects.pagination ● PaginationInput! non-null input

Type

ExternalProjectCollection object

ExternalProjectCollection 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 companies query first and use data.companies.collection[].id as companyId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetCheckmarxExternalProjects($companyId: ID!, $pagination: PaginationInput!) {\n  checkmarxExternalProjects(companyId: $companyId, pagination: $pagination) { collection { id name branches } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>","pagination":{}}}'

JavaScript

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 GetCheckmarxExternalProjects($companyId: ID!, $pagination: PaginationInput!) {\n  checkmarxExternalProjects(companyId: $companyId, pagination: $pagination) { collection { id name branches } metadata { currentPage limitValue totalCount } }\n}",
    variables: {
    "companyId": "<company_id>",
    "pagination": {}
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

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 GetCheckmarxExternalProjects($companyId: ID!, $pagination: PaginationInput!) {\n  checkmarxExternalProjects(companyId: $companyId, pagination: $pagination) { collection { id name branches } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{\"companyId\":\"<company_id>\",\"pagination\":{}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])