assetTypeChangePreview

Preview a change of asset type, or a split of an asset along security disciplines

assetTypeChangePreview(
  companyId: ID!
  assetId: ID!
  targetType: AssetTypeChangeTarget
  disciplines: [AssetScanDiscipline!]
): AssetTypeChangePreview!

Arguments

assetTypeChangePreview.companyId ● ID! non-null scalar

assetTypeChangePreview.assetId ● ID! non-null scalar

assetTypeChangePreview.targetType ● AssetTypeChangeTarget enum

The type being considered. Supply it to have urlRequired answered.

assetTypeChangePreview.disciplines ● [AssetScanDiscipline!] list enum

The disciplines a split would move. Supply it together with targetType to get plan.

Type

AssetTypeChangePreview object

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 GetAssetTypeChangePreview($companyId: ID!, $assetId: ID!) {\n  assetTypeChangePreview(companyId: $companyId, assetId: $assetId) { availableTargets blockedReason branchCollisionCount }\n}","variables":{"companyId":"<company_id>","assetId":"<asset_id>"}}'

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 GetAssetTypeChangePreview($companyId: ID!, $assetId: ID!) {\n  assetTypeChangePreview(companyId: $companyId, assetId: $assetId) { availableTargets blockedReason branchCollisionCount }\n}",
    variables: {
    "companyId": "<company_id>",
    "assetId": "<asset_id>"
},
  }),
});

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 GetAssetTypeChangePreview($companyId: ID!, $assetId: ID!) {\n  assetTypeChangePreview(companyId: $companyId, assetId: $assetId) { availableTargets blockedReason branchCollisionCount }\n}",
        'variables': json.loads("{\"companyId\":\"<company_id>\",\"assetId\":\"<asset_id>\"}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])