Code Insight 2021 R2 REST API Documentation

Component

componentSearch

Component Search

Search for the components based on the given input and return list of components which includes registered,popular and unpopular.Response will not include vulnerabilities and licenses of the version


/components/search

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//components/search?searchBy=&filter=&searchTerm=&includeVersions=&vendor=&product=&forgeName=&projectName=&packageName=&groupId=&artifactId=&moduleOrDistributionName=&packageOrDistributionName=&author=&repositoryName=&vendorName=&gemName=&crate=&limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ComponentApi;

import java.io.File;
import java.util.*;

public class ComponentApiExample {

    public static void main(String[] args) {
        
        ComponentApi apiInstance = new ComponentApi();
        String searchBy = searchBy_example; // String | Search Type. default is NAME.
        String authorization = authorization_example; // String | Bearer JWT Token
        String filter = filter_example; // String | Search Filter. This is required for searchBy NAME, default is ALL_TERMS.
        String searchTerm = searchTerm_example; // String | Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component.
        Boolean includeVersions = true; // Boolean | If true , response will include versions as well.
        String vendor = vendor_example; // String | Vendor name
        String product = product_example; // String | Product name
        String forgeName = forgeName_example; // String | Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE
        String projectName = projectName_example; // String | Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code
        String packageName = packageName_example; // String | Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project
        String groupId = groupId_example; // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
        String artifactId = artifactId_example; // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
        String moduleOrDistributionName = moduleOrDistributionName_example; // String | Required param for forge: CPAN 
        String packageOrDistributionName = packageOrDistributionName_example; // String | Required param for forge: CRAN | Fedora Koji
        String author = author_example; // String | Required param for forge: GitHub 
        String repositoryName = repositoryName_example; // String | Required param for forge: GitHub 
        String vendorName = vendorName_example; // String | Required param for forge: Packagist
        String gemName = gemName_example; // String | Required param for forge: RubyGems
        String crate = crate_example; // String | Required param for forge: crates.io
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            ComponentListModel result = apiInstance.componentSearch(searchBy, authorization, filter, searchTerm, includeVersions, vendor, product, forgeName, projectName, packageName, groupId, artifactId, moduleOrDistributionName, packageOrDistributionName, author, repositoryName, vendorName, gemName, crate, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#componentSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ComponentApi;

public class ComponentApiExample {

    public static void main(String[] args) {
        ComponentApi apiInstance = new ComponentApi();
        String searchBy = searchBy_example; // String | Search Type. default is NAME.
        String authorization = authorization_example; // String | Bearer JWT Token
        String filter = filter_example; // String | Search Filter. This is required for searchBy NAME, default is ALL_TERMS.
        String searchTerm = searchTerm_example; // String | Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component.
        Boolean includeVersions = true; // Boolean | If true , response will include versions as well.
        String vendor = vendor_example; // String | Vendor name
        String product = product_example; // String | Product name
        String forgeName = forgeName_example; // String | Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE
        String projectName = projectName_example; // String | Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code
        String packageName = packageName_example; // String | Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project
        String groupId = groupId_example; // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
        String artifactId = artifactId_example; // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
        String moduleOrDistributionName = moduleOrDistributionName_example; // String | Required param for forge: CPAN 
        String packageOrDistributionName = packageOrDistributionName_example; // String | Required param for forge: CRAN | Fedora Koji
        String author = author_example; // String | Required param for forge: GitHub 
        String repositoryName = repositoryName_example; // String | Required param for forge: GitHub 
        String vendorName = vendorName_example; // String | Required param for forge: Packagist
        String gemName = gemName_example; // String | Required param for forge: RubyGems
        String crate = crate_example; // String | Required param for forge: crates.io
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            ComponentListModel result = apiInstance.componentSearch(searchBy, authorization, filter, searchTerm, includeVersions, vendor, product, forgeName, projectName, packageName, groupId, artifactId, moduleOrDistributionName, packageOrDistributionName, author, repositoryName, vendorName, gemName, crate, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#componentSearch");
            e.printStackTrace();
        }
    }
}
String *searchBy = searchBy_example; // Search Type. default is NAME.
String *authorization = authorization_example; // Bearer JWT Token (default to )
String *filter = filter_example; // Search Filter. This is required for searchBy NAME, default is ALL_TERMS. (optional)
String *searchTerm = searchTerm_example; // Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component. (optional)
Boolean *includeVersions = true; // If true , response will include versions as well. (optional)
String *vendor = vendor_example; // Vendor name (optional)
String *product = product_example; // Product name (optional)
String *forgeName = forgeName_example; // Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE (optional)
String *projectName = projectName_example; // Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code (optional)
String *packageName = packageName_example; // Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project (optional)
String *groupId = groupId_example; // Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (optional)
String *artifactId = artifactId_example; // Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (optional)
String *moduleOrDistributionName = moduleOrDistributionName_example; // Required param for forge: CPAN  (optional)
String *packageOrDistributionName = packageOrDistributionName_example; // Required param for forge: CRAN | Fedora Koji (optional)
String *author = author_example; // Required param for forge: GitHub  (optional)
String *repositoryName = repositoryName_example; // Required param for forge: GitHub  (optional)
String *vendorName = vendorName_example; // Required param for forge: Packagist (optional)
String *gemName = gemName_example; // Required param for forge: RubyGems (optional)
String *crate = crate_example; // Required param for forge: crates.io (optional)
Integer *limit = 56; // Page Size. Number Of Records to fetch per page (optional)
Integer *offset = 56; // Page Number. Index of the page to start with(starts from 1) (optional)

ComponentApi *apiInstance = [[ComponentApi alloc] init];

// Component Search
[apiInstance componentSearchWith:searchBy
    authorization:authorization
    filter:filter
    searchTerm:searchTerm
    includeVersions:includeVersions
    vendor:vendor
    product:product
    forgeName:forgeName
    projectName:projectName
    packageName:packageName
    groupId:groupId
    artifactId:artifactId
    moduleOrDistributionName:moduleOrDistributionName
    packageOrDistributionName:packageOrDistributionName
    author:author
    repositoryName:repositoryName
    vendorName:vendorName
    gemName:gemName
    crate:crate
    limit:limit
    offset:offset
              completionHandler: ^(ComponentListModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ComponentApi()

var searchBy = searchBy_example; // {String} Search Type. default is NAME.

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'filter': filter_example, // {String} Search Filter. This is required for searchBy NAME, default is ALL_TERMS.
  'searchTerm': searchTerm_example, // {String} Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component.
  'includeVersions': true, // {Boolean} If true , response will include versions as well.
  'vendor': vendor_example, // {String} Vendor name
  'product': product_example, // {String} Product name
  'forgeName': forgeName_example, // {String} Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE
  'projectName': projectName_example, // {String} Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code
  'packageName': packageName_example, // {String} Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project
  'groupId': groupId_example, // {String} Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
  'artifactId': artifactId_example, // {String} Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
  'moduleOrDistributionName': moduleOrDistributionName_example, // {String} Required param for forge: CPAN 
  'packageOrDistributionName': packageOrDistributionName_example, // {String} Required param for forge: CRAN | Fedora Koji
  'author': author_example, // {String} Required param for forge: GitHub 
  'repositoryName': repositoryName_example, // {String} Required param for forge: GitHub 
  'vendorName': vendorName_example, // {String} Required param for forge: Packagist
  'gemName': gemName_example, // {String} Required param for forge: RubyGems
  'crate': crate_example, // {String} Required param for forge: crates.io
  'limit': 56, // {Integer} Page Size. Number Of Records to fetch per page
  'offset': 56 // {Integer} Page Number. Index of the page to start with(starts from 1)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.componentSearch(searchBy, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class componentSearchExample
    {
        public void main()
        {
            
            var apiInstance = new ComponentApi();
            var searchBy = searchBy_example;  // String | Search Type. default is NAME.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var filter = filter_example;  // String | Search Filter. This is required for searchBy NAME, default is ALL_TERMS. (optional) 
            var searchTerm = searchTerm_example;  // String | Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component. (optional) 
            var includeVersions = true;  // Boolean | If true , response will include versions as well. (optional) 
            var vendor = vendor_example;  // String | Vendor name (optional) 
            var product = product_example;  // String | Product name (optional) 
            var forgeName = forgeName_example;  // String | Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE (optional) 
            var projectName = projectName_example;  // String | Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code (optional) 
            var packageName = packageName_example;  // String | Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project (optional) 
            var groupId = groupId_example;  // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (optional) 
            var artifactId = artifactId_example;  // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (optional) 
            var moduleOrDistributionName = moduleOrDistributionName_example;  // String | Required param for forge: CPAN  (optional) 
            var packageOrDistributionName = packageOrDistributionName_example;  // String | Required param for forge: CRAN | Fedora Koji (optional) 
            var author = author_example;  // String | Required param for forge: GitHub  (optional) 
            var repositoryName = repositoryName_example;  // String | Required param for forge: GitHub  (optional) 
            var vendorName = vendorName_example;  // String | Required param for forge: Packagist (optional) 
            var gemName = gemName_example;  // String | Required param for forge: RubyGems (optional) 
            var crate = crate_example;  // String | Required param for forge: crates.io (optional) 
            var limit = 56;  // Integer | Page Size. Number Of Records to fetch per page (optional) 
            var offset = 56;  // Integer | Page Number. Index of the page to start with(starts from 1) (optional) 

            try
            {
                // Component Search
                ComponentListModel result = apiInstance.componentSearch(searchBy, authorization, filter, searchTerm, includeVersions, vendor, product, forgeName, projectName, packageName, groupId, artifactId, moduleOrDistributionName, packageOrDistributionName, author, repositoryName, vendorName, gemName, crate, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ComponentApi.componentSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ComponentApi();
$searchBy = searchBy_example; // String | Search Type. default is NAME.
$authorization = authorization_example; // String | Bearer JWT Token
$filter = filter_example; // String | Search Filter. This is required for searchBy NAME, default is ALL_TERMS.
$searchTerm = searchTerm_example; // String | Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component.
$includeVersions = true; // Boolean | If true , response will include versions as well.
$vendor = vendor_example; // String | Vendor name
$product = product_example; // String | Product name
$forgeName = forgeName_example; // String | Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE
$projectName = projectName_example; // String | Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code
$packageName = packageName_example; // String | Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project
$groupId = groupId_example; // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
$artifactId = artifactId_example; // String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
$moduleOrDistributionName = moduleOrDistributionName_example; // String | Required param for forge: CPAN 
$packageOrDistributionName = packageOrDistributionName_example; // String | Required param for forge: CRAN | Fedora Koji
$author = author_example; // String | Required param for forge: GitHub 
$repositoryName = repositoryName_example; // String | Required param for forge: GitHub 
$vendorName = vendorName_example; // String | Required param for forge: Packagist
$gemName = gemName_example; // String | Required param for forge: RubyGems
$crate = crate_example; // String | Required param for forge: crates.io
$limit = 56; // Integer | Page Size. Number Of Records to fetch per page
$offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)

try {
    $result = $api_instance->componentSearch($searchBy, $authorization, $filter, $searchTerm, $includeVersions, $vendor, $product, $forgeName, $projectName, $packageName, $groupId, $artifactId, $moduleOrDistributionName, $packageOrDistributionName, $author, $repositoryName, $vendorName, $gemName, $crate, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComponentApi->componentSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ComponentApi;

my $api_instance = WWW::SwaggerClient::ComponentApi->new();
my $searchBy = searchBy_example; # String | Search Type. default is NAME.
my $authorization = authorization_example; # String | Bearer JWT Token
my $filter = filter_example; # String | Search Filter. This is required for searchBy NAME, default is ALL_TERMS.
my $searchTerm = searchTerm_example; # String | Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component.
my $includeVersions = true; # Boolean | If true , response will include versions as well.
my $vendor = vendor_example; # String | Vendor name
my $product = product_example; # String | Product name
my $forgeName = forgeName_example; # String | Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE
my $projectName = projectName_example; # String | Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code
my $packageName = packageName_example; # String | Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project
my $groupId = groupId_example; # String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
my $artifactId = artifactId_example; # String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
my $moduleOrDistributionName = moduleOrDistributionName_example; # String | Required param for forge: CPAN 
my $packageOrDistributionName = packageOrDistributionName_example; # String | Required param for forge: CRAN | Fedora Koji
my $author = author_example; # String | Required param for forge: GitHub 
my $repositoryName = repositoryName_example; # String | Required param for forge: GitHub 
my $vendorName = vendorName_example; # String | Required param for forge: Packagist
my $gemName = gemName_example; # String | Required param for forge: RubyGems
my $crate = crate_example; # String | Required param for forge: crates.io
my $limit = 56; # Integer | Page Size. Number Of Records to fetch per page
my $offset = 56; # Integer | Page Number. Index of the page to start with(starts from 1)

eval { 
    my $result = $api_instance->componentSearch(searchBy => $searchBy, authorization => $authorization, filter => $filter, searchTerm => $searchTerm, includeVersions => $includeVersions, vendor => $vendor, product => $product, forgeName => $forgeName, projectName => $projectName, packageName => $packageName, groupId => $groupId, artifactId => $artifactId, moduleOrDistributionName => $moduleOrDistributionName, packageOrDistributionName => $packageOrDistributionName, author => $author, repositoryName => $repositoryName, vendorName => $vendorName, gemName => $gemName, crate => $crate, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ComponentApi->componentSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ComponentApi()
searchBy = searchBy_example # String | Search Type. default is NAME.
authorization = authorization_example # String | Bearer JWT Token (default to )
filter = filter_example # String | Search Filter. This is required for searchBy NAME, default is ALL_TERMS. (optional)
searchTerm = searchTerm_example # String | Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component. (optional)
includeVersions = true # Boolean | If true , response will include versions as well. (optional)
vendor = vendor_example # String | Vendor name (optional)
product = product_example # String | Product name (optional)
forgeName = forgeName_example # String | Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE (optional)
projectName = projectName_example # String | Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code (optional)
packageName = packageName_example # String | Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project (optional)
groupId = groupId_example # String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (optional)
artifactId = artifactId_example # String | Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (optional)
moduleOrDistributionName = moduleOrDistributionName_example # String | Required param for forge: CPAN  (optional)
packageOrDistributionName = packageOrDistributionName_example # String | Required param for forge: CRAN | Fedora Koji (optional)
author = author_example # String | Required param for forge: GitHub  (optional)
repositoryName = repositoryName_example # String | Required param for forge: GitHub  (optional)
vendorName = vendorName_example # String | Required param for forge: Packagist (optional)
gemName = gemName_example # String | Required param for forge: RubyGems (optional)
crate = crate_example # String | Required param for forge: crates.io (optional)
limit = 56 # Integer | Page Size. Number Of Records to fetch per page (optional)
offset = 56 # Integer | Page Number. Index of the page to start with(starts from 1) (optional)

try: 
    # Component Search
    api_response = api_instance.component_search(searchBy, authorization, filter=filter, searchTerm=searchTerm, includeVersions=includeVersions, vendor=vendor, product=product, forgeName=forgeName, projectName=projectName, packageName=packageName, groupId=groupId, artifactId=artifactId, moduleOrDistributionName=moduleOrDistributionName, packageOrDistributionName=packageOrDistributionName, author=author, repositoryName=repositoryName, vendorName=vendorName, gemName=gemName, crate=crate, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComponentApi->componentSearch: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
searchBy*
String
Search Type. default is NAME.
Required
filter
String
Search Filter. This is required for searchBy NAME, default is ALL_TERMS.
searchTerm
String
Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component.
includeVersions
Boolean
If true , response will include versions as well.
vendor
String
Vendor name
product
String
Product name
forgeName
String
Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE
projectName
String
Required param for forges: SourceForge|Apache|MySQL AB|Java.net|GNU|Free Software Directory|CodePlex|Savannah|Google Code
packageName
String
Required param for forges: Hackage|NuGet Gallery|npm|PyPI|Packagist|CentOS Project
groupId
String
Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
artifactId
String
Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2
moduleOrDistributionName
String
Required param for forge: CPAN
packageOrDistributionName
String
Required param for forge: CRAN | Fedora Koji
author
String
Required param for forge: GitHub
repositoryName
String
Required param for forge: GitHub
vendorName
String
Required param for forge: Packagist
gemName
String
Required param for forge: RubyGems
crate
String
Required param for forge: crates.io
limit
Integer (int32)
Page Size. Number Of Records to fetch per page
offset
Integer (int32)
Page Number. Index of the page to start with(starts from 1)

Responses

Status: 200 - OK

Status: 400 - Bad request

Status: 500 - Internal Server Error


createComponentVersion

Create a component custom version

Create a component custom version


/components/{componentId}/versions

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//components/{componentId}/versions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ComponentApi;

import java.io.File;
import java.util.*;

public class ComponentApiExample {

    public static void main(String[] args) {
        
        ComponentApi apiInstance = new ComponentApi();
        Long componentId = 789; // Long | ID of the Component
        VersionModel body = ; // VersionModel | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createComponentVersion(componentId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#createComponentVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ComponentApi;

public class ComponentApiExample {

    public static void main(String[] args) {
        ComponentApi apiInstance = new ComponentApi();
        Long componentId = 789; // Long | ID of the Component
        VersionModel body = ; // VersionModel | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createComponentVersion(componentId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#createComponentVersion");
            e.printStackTrace();
        }
    }
}
Long *componentId = 789; // ID of the Component
VersionModel *body = ; // 
String *authorization = authorization_example; //  (default to )

ComponentApi *apiInstance = [[ComponentApi alloc] init];

// Create a component custom version
[apiInstance createComponentVersionWith:componentId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ComponentApi()

var componentId = 789; // {Long} ID of the Component

var body = ; // {VersionModel} 

var authorization = authorization_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createComponentVersion(componentId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createComponentVersionExample
    {
        public void main()
        {
            
            var apiInstance = new ComponentApi();
            var componentId = 789;  // Long | ID of the Component
            var body = new VersionModel(); // VersionModel | 
            var authorization = authorization_example;  // String |  (default to )

            try
            {
                // Create a component custom version
                apiInstance.createComponentVersion(componentId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ComponentApi.createComponentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ComponentApi();
$componentId = 789; // Long | ID of the Component
$body = ; // VersionModel | 
$authorization = authorization_example; // String | 

try {
    $api_instance->createComponentVersion($componentId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ComponentApi->createComponentVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ComponentApi;

my $api_instance = WWW::SwaggerClient::ComponentApi->new();
my $componentId = 789; # Long | ID of the Component
my $body = WWW::SwaggerClient::Object::VersionModel->new(); # VersionModel | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->createComponentVersion(componentId => $componentId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ComponentApi->createComponentVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ComponentApi()
componentId = 789 # Long | ID of the Component
body =  # VersionModel | 
authorization = authorization_example # String |  (default to )

try: 
    # Create a component custom version
    api_instance.create_component_version(componentId, body, authorization)
except ApiException as e:
    print("Exception when calling ComponentApi->createComponentVersion: %s\n" % e)

Parameters

Path parameters
Name Description
componentId*
Long (int64)
ID of the Component
Required
Header parameters
Name Description
Authorization*
String
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


createCustomComponent

Create a custom component

Creates a custom component


/components

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//components"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ComponentApi;

import java.io.File;
import java.util.*;

public class ComponentApiExample {

    public static void main(String[] args) {
        
        ComponentApi apiInstance = new ComponentApi();
        ComponentModel body = ; // ComponentModel | To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createCustomComponent(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#createCustomComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ComponentApi;

public class ComponentApiExample {

    public static void main(String[] args) {
        ComponentApi apiInstance = new ComponentApi();
        ComponentModel body = ; // ComponentModel | To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createCustomComponent(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#createCustomComponent");
            e.printStackTrace();
        }
    }
}
ComponentModel *body = ; // To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io
String *authorization = authorization_example; // Bearer JWT Token (default to )

ComponentApi *apiInstance = [[ComponentApi alloc] init];

// Create a custom component
[apiInstance createCustomComponentWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ComponentApi()

var body = ; // {ComponentModel} To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCustomComponent(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createCustomComponentExample
    {
        public void main()
        {
            
            var apiInstance = new ComponentApi();
            var body = new ComponentModel(); // ComponentModel | To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create a custom component
                apiInstance.createCustomComponent(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ComponentApi.createCustomComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ComponentApi();
$body = ; // ComponentModel | To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createCustomComponent($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ComponentApi->createCustomComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ComponentApi;

my $api_instance = WWW::SwaggerClient::ComponentApi->new();
my $body = WWW::SwaggerClient::Object::ComponentModel->new(); # ComponentModel | To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createCustomComponent(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ComponentApi->createCustomComponent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ComponentApi()
body =  # ComponentModel | To create a custom component the name, title and url field is required. 
 Allowable values of forgeId(Optional) are 
 1 : Other(This will be used as default when none is supplied) | 2 : SourceForge | 3 : Apache | 5 : MySQL AB |11 : kernel.org | 53 : Mozilla | 78 : Java.net | 87 : GNU | 175 : Free Software Directory | 176 : CodePlex | 186 : Savannah | 248 : CPAN | 419 : Google Code | 628 : Ibiblio Maven2 | 696 : GitHub | 2033 : NuGet Gallery | 2037 : npm |2039 : RubyGems | 2040 : CentOS Project | 2067 : PyPI | 2070 : Packagist | 2073 : Google's Maven Repository | 2076 : crates.io
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create a custom component
    api_instance.create_custom_component(body, authorization)
except ApiException as e:
    print("Exception when calling ComponentApi->createCustomComponent: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 500 - Internal Server Error


getComponent

Get Component

Get Component by id.


/components/{componentId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//components/{componentId}?vulnerabilitySummary=&cvssVersion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ComponentApi;

import java.io.File;
import java.util.*;

public class ComponentApiExample {

    public static void main(String[] args) {
        
        ComponentApi apiInstance = new ComponentApi();
        Long componentId = 789; // Long | ID of the Component
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean vulnerabilitySummary = true; // Boolean | If true , display vulnerabilty summary details and hide vulnerability list
        String cvssVersion = cvssVersion_example; // String | CVSS Version : This field is required only if vulnerabilitySummary is set to true
        try {
            ExtendedComponentModel result = apiInstance.getComponent(componentId, authorization, vulnerabilitySummary, cvssVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#getComponent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ComponentApi;

public class ComponentApiExample {

    public static void main(String[] args) {
        ComponentApi apiInstance = new ComponentApi();
        Long componentId = 789; // Long | ID of the Component
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean vulnerabilitySummary = true; // Boolean | If true , display vulnerabilty summary details and hide vulnerability list
        String cvssVersion = cvssVersion_example; // String | CVSS Version : This field is required only if vulnerabilitySummary is set to true
        try {
            ExtendedComponentModel result = apiInstance.getComponent(componentId, authorization, vulnerabilitySummary, cvssVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#getComponent");
            e.printStackTrace();
        }
    }
}
Long *componentId = 789; // ID of the Component
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *vulnerabilitySummary = true; // If true , display vulnerabilty summary details and hide vulnerability list (optional) (default to false)
String *cvssVersion = cvssVersion_example; // CVSS Version : This field is required only if vulnerabilitySummary is set to true (optional)

ComponentApi *apiInstance = [[ComponentApi alloc] init];

// Get Component
[apiInstance getComponentWith:componentId
    authorization:authorization
    vulnerabilitySummary:vulnerabilitySummary
    cvssVersion:cvssVersion
              completionHandler: ^(ExtendedComponentModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ComponentApi()

var componentId = 789; // {Long} ID of the Component

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'vulnerabilitySummary': true, // {Boolean} If true , display vulnerabilty summary details and hide vulnerability list
  'cvssVersion': cvssVersion_example // {String} CVSS Version : This field is required only if vulnerabilitySummary is set to true
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComponent(componentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getComponentExample
    {
        public void main()
        {
            
            var apiInstance = new ComponentApi();
            var componentId = 789;  // Long | ID of the Component
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var vulnerabilitySummary = true;  // Boolean | If true , display vulnerabilty summary details and hide vulnerability list (optional)  (default to false)
            var cvssVersion = cvssVersion_example;  // String | CVSS Version : This field is required only if vulnerabilitySummary is set to true (optional) 

            try
            {
                // Get Component
                ExtendedComponentModel result = apiInstance.getComponent(componentId, authorization, vulnerabilitySummary, cvssVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ComponentApi.getComponent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ComponentApi();
$componentId = 789; // Long | ID of the Component
$authorization = authorization_example; // String | Bearer JWT Token
$vulnerabilitySummary = true; // Boolean | If true , display vulnerabilty summary details and hide vulnerability list
$cvssVersion = cvssVersion_example; // String | CVSS Version : This field is required only if vulnerabilitySummary is set to true

try {
    $result = $api_instance->getComponent($componentId, $authorization, $vulnerabilitySummary, $cvssVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComponentApi->getComponent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ComponentApi;

my $api_instance = WWW::SwaggerClient::ComponentApi->new();
my $componentId = 789; # Long | ID of the Component
my $authorization = authorization_example; # String | Bearer JWT Token
my $vulnerabilitySummary = true; # Boolean | If true , display vulnerabilty summary details and hide vulnerability list
my $cvssVersion = cvssVersion_example; # String | CVSS Version : This field is required only if vulnerabilitySummary is set to true

eval { 
    my $result = $api_instance->getComponent(componentId => $componentId, authorization => $authorization, vulnerabilitySummary => $vulnerabilitySummary, cvssVersion => $cvssVersion);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ComponentApi->getComponent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ComponentApi()
componentId = 789 # Long | ID of the Component
authorization = authorization_example # String | Bearer JWT Token (default to )
vulnerabilitySummary = true # Boolean | If true , display vulnerabilty summary details and hide vulnerability list (optional) (default to false)
cvssVersion = cvssVersion_example # String | CVSS Version : This field is required only if vulnerabilitySummary is set to true (optional)

try: 
    # Get Component
    api_response = api_instance.get_component(componentId, authorization, vulnerabilitySummary=vulnerabilitySummary, cvssVersion=cvssVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComponentApi->getComponent: %s\n" % e)

Parameters

Path parameters
Name Description
componentId*
Long (int64)
ID of the Component
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
vulnerabilitySummary
Boolean
If true , display vulnerabilty summary details and hide vulnerability list
cvssVersion
String
CVSS Version : This field is required only if vulnerabilitySummary is set to true

Responses

Status: 200 - OK

Status: 404 - Not Found

Status: 500 - Internal Server Error


getVulnerabilties1

Get Component version vulnerabilities

Get vulnerability details of a component version


/components/{versionId}/vulnerabilities

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//components/{versionId}/vulnerabilities?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ComponentApi;

import java.io.File;
import java.util.*;

public class ComponentApiExample {

    public static void main(String[] args) {
        
        ComponentApi apiInstance = new ComponentApi();
        Long versionId = 789; // Long | ID of the component version
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            apiInstance.getVulnerabilties1(versionId, authorization, limit, offset);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#getVulnerabilties1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ComponentApi;

public class ComponentApiExample {

    public static void main(String[] args) {
        ComponentApi apiInstance = new ComponentApi();
        Long versionId = 789; // Long | ID of the component version
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            apiInstance.getVulnerabilties1(versionId, authorization, limit, offset);
        } catch (ApiException e) {
            System.err.println("Exception when calling ComponentApi#getVulnerabilties1");
            e.printStackTrace();
        }
    }
}
Long *versionId = 789; // ID of the component version
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *limit = 56; // Page Size. Number Of Records to fetch per page (optional) (default to 25)
Integer *offset = 56; // Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)

ComponentApi *apiInstance = [[ComponentApi alloc] init];

// Get Component version vulnerabilities
[apiInstance getVulnerabilties1With:versionId
    authorization:authorization
    limit:limit
    offset:offset
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ComponentApi()

var versionId = 789; // {Long} ID of the component version

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'limit': 56, // {Integer} Page Size. Number Of Records to fetch per page
  'offset': 56 // {Integer} Page Number. Index of the page to start with(starts from 1)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getVulnerabilties1(versionId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVulnerabilties1Example
    {
        public void main()
        {
            
            var apiInstance = new ComponentApi();
            var versionId = 789;  // Long | ID of the component version
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var limit = 56;  // Integer | Page Size. Number Of Records to fetch per page (optional)  (default to 25)
            var offset = 56;  // Integer | Page Number. Index of the page to start with(starts from 1) (optional)  (default to 1)

            try
            {
                // Get Component version vulnerabilities
                apiInstance.getVulnerabilties1(versionId, authorization, limit, offset);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ComponentApi.getVulnerabilties1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ComponentApi();
$versionId = 789; // Long | ID of the component version
$authorization = authorization_example; // String | Bearer JWT Token
$limit = 56; // Integer | Page Size. Number Of Records to fetch per page
$offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)

try {
    $api_instance->getVulnerabilties1($versionId, $authorization, $limit, $offset);
} catch (Exception $e) {
    echo 'Exception when calling ComponentApi->getVulnerabilties1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ComponentApi;

my $api_instance = WWW::SwaggerClient::ComponentApi->new();
my $versionId = 789; # Long | ID of the component version
my $authorization = authorization_example; # String | Bearer JWT Token
my $limit = 56; # Integer | Page Size. Number Of Records to fetch per page
my $offset = 56; # Integer | Page Number. Index of the page to start with(starts from 1)

eval { 
    $api_instance->getVulnerabilties1(versionId => $versionId, authorization => $authorization, limit => $limit, offset => $offset);
};
if ($@) {
    warn "Exception when calling ComponentApi->getVulnerabilties1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ComponentApi()
versionId = 789 # Long | ID of the component version
authorization = authorization_example # String | Bearer JWT Token (default to )
limit = 56 # Integer | Page Size. Number Of Records to fetch per page (optional) (default to 25)
offset = 56 # Integer | Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)

try: 
    # Get Component version vulnerabilities
    api_instance.get_vulnerabilties1(versionId, authorization, limit=limit, offset=offset)
except ApiException as e:
    print("Exception when calling ComponentApi->getVulnerabilties1: %s\n" % e)

Parameters

Path parameters
Name Description
versionId*
Long (int64)
ID of the component version
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
limit
Integer (int32)
Page Size. Number Of Records to fetch per page
offset
Integer (int32)
Page Number. Index of the page to start with(starts from 1)

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


DeprecatedAPIs

componentLookup

Component Lookup

This API is Deprecated and new API is codeinsight/api/components/search


/component/lookup

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//component/lookup?keyword=&size=&page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedAPIsApi;

import java.io.File;
import java.util.*;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        String keyword = keyword_example; // String | Any Keyword
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer size = 56; // Integer | Page Size
        Integer page = 56; // Integer | Page Number
        try {
            ComponentRestFormat result = apiInstance.componentLookup(keyword, authorization, size, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#componentLookup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedAPIsApi;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        String keyword = keyword_example; // String | Any Keyword
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer size = 56; // Integer | Page Size
        Integer page = 56; // Integer | Page Number
        try {
            ComponentRestFormat result = apiInstance.componentLookup(keyword, authorization, size, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#componentLookup");
            e.printStackTrace();
        }
    }
}
String *keyword = keyword_example; // Any Keyword
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *size = 56; // Page Size (optional) (default to 100)
Integer *page = 56; // Page Number (optional) (default to 1)

DeprecatedAPIsApi *apiInstance = [[DeprecatedAPIsApi alloc] init];

// Component Lookup
[apiInstance componentLookupWith:keyword
    authorization:authorization
    size:size
    page:page
              completionHandler: ^(ComponentRestFormat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.DeprecatedAPIsApi()

var keyword = keyword_example; // {String} Any Keyword

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'size': 56, // {Integer} Page Size
  'page': 56 // {Integer} Page Number
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.componentLookup(keyword, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class componentLookupExample
    {
        public void main()
        {
            
            var apiInstance = new DeprecatedAPIsApi();
            var keyword = keyword_example;  // String | Any Keyword
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var size = 56;  // Integer | Page Size (optional)  (default to 100)
            var page = 56;  // Integer | Page Number (optional)  (default to 1)

            try
            {
                // Component Lookup
                ComponentRestFormat result = apiInstance.componentLookup(keyword, authorization, size, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedAPIsApi.componentLookup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DeprecatedAPIsApi();
$keyword = keyword_example; // String | Any Keyword
$authorization = authorization_example; // String | Bearer JWT Token
$size = 56; // Integer | Page Size
$page = 56; // Integer | Page Number

try {
    $result = $api_instance->componentLookup($keyword, $authorization, $size, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedAPIsApi->componentLookup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedAPIsApi;

my $api_instance = WWW::SwaggerClient::DeprecatedAPIsApi->new();
my $keyword = keyword_example; # String | Any Keyword
my $authorization = authorization_example; # String | Bearer JWT Token
my $size = 56; # Integer | Page Size
my $page = 56; # Integer | Page Number

eval { 
    my $result = $api_instance->componentLookup(keyword => $keyword, authorization => $authorization, size => $size, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedAPIsApi->componentLookup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DeprecatedAPIsApi()
keyword = keyword_example # String | Any Keyword
authorization = authorization_example # String | Bearer JWT Token (default to )
size = 56 # Integer | Page Size (optional) (default to 100)
page = 56 # Integer | Page Number (optional) (default to 1)

try: 
    # Component Lookup
    api_response = api_instance.component_lookup(keyword, authorization, size=size, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedAPIsApi->componentLookup: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
keyword*
String
Any Keyword
Required
size
Integer (int32)
Page Size
page
Integer (int32)
Page Number

Responses

Status: 200 - OK

Status: 400 - Bad request

Status: 500 - Internal Server Error


createProject1

Create Project

Use the enhanced '/projects' api.


/project/createProject

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//project/createProject"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedAPIsApi;

import java.io.File;
import java.util.*;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        CreateProjectModel body = ; // CreateProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'Integer' result = apiInstance.createProject1(body, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#createProject1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedAPIsApi;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        CreateProjectModel body = ; // CreateProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'Integer' result = apiInstance.createProject1(body, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#createProject1");
            e.printStackTrace();
        }
    }
}
CreateProjectModel *body = ; // To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
String *authorization = authorization_example; // Bearer JWT Token (default to )

DeprecatedAPIsApi *apiInstance = [[DeprecatedAPIsApi alloc] init];

// Create Project
[apiInstance createProject1With:body
    authorization:authorization
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.DeprecatedAPIsApi()

var body = ; // {CreateProjectModel} To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createProject1(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProject1Example
    {
        public void main()
        {
            
            var apiInstance = new DeprecatedAPIsApi();
            var body = new CreateProjectModel(); // CreateProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create Project
                'Integer' result = apiInstance.createProject1(body, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedAPIsApi.createProject1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DeprecatedAPIsApi();
$body = ; // CreateProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->createProject1($body, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedAPIsApi->createProject1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedAPIsApi;

my $api_instance = WWW::SwaggerClient::DeprecatedAPIsApi->new();
my $body = WWW::SwaggerClient::Object::CreateProjectModel->new(); # CreateProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->createProject1(body => $body, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedAPIsApi->createProject1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DeprecatedAPIsApi()
body =  # CreateProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create Project
    api_response = api_instance.create_project1(body, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedAPIsApi->createProject1: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 500 - Error : error message


generateReport1

Generate Report

This API is deprecated please refer to /projects/{projectId}/reports/{reportId}/generate to Generate a report. Refer /projects/{projectId}/reports/{reportId}/download to Download a report. Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For CUSTOM_REPORT provide the name of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects. Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL. When calling this API from a REST client, you need to redirect output to a zip file as follows curl -X GET "http://HOST:PORT/codeinsight/api/project/generateReport?reportType=REPORT_TYPE&projectId=PROJECT_ID" -H "accept: application/json" -H "Authorization: Bearer JWT_TOKEN" > report.zip


/project/generateReport

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//project/generateReport?projectId=&reportType=&otherProjectId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedAPIsApi;

import java.io.File;
import java.util.*;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        Integer projectId = 56; // Integer | ID of the Project
        String reportType = reportType_example; // String | Report Type
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer otherProjectId = 56; // Integer | Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true.
        try {
            InputStream result = apiInstance.generateReport1(projectId, reportType, authorization, otherProjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#generateReport1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedAPIsApi;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        Integer projectId = 56; // Integer | ID of the Project
        String reportType = reportType_example; // String | Report Type
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer otherProjectId = 56; // Integer | Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true.
        try {
            InputStream result = apiInstance.generateReport1(projectId, reportType, authorization, otherProjectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#generateReport1");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *reportType = reportType_example; // Report Type
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *otherProjectId = 56; // Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true. (optional)

DeprecatedAPIsApi *apiInstance = [[DeprecatedAPIsApi alloc] init];

// Generate Report
[apiInstance generateReport1With:projectId
    reportType:reportType
    authorization:authorization
    otherProjectId:otherProjectId
              completionHandler: ^(InputStream output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.DeprecatedAPIsApi()

var projectId = 56; // {Integer} ID of the Project

var reportType = reportType_example; // {String} Report Type

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'otherProjectId': 56 // {Integer} Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateReport1(projectId, reportType, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class generateReport1Example
    {
        public void main()
        {
            
            var apiInstance = new DeprecatedAPIsApi();
            var projectId = 56;  // Integer | ID of the Project
            var reportType = reportType_example;  // String | Report Type
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var otherProjectId = 56;  // Integer | Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true. (optional) 

            try
            {
                // Generate Report
                InputStream result = apiInstance.generateReport1(projectId, reportType, authorization, otherProjectId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedAPIsApi.generateReport1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DeprecatedAPIsApi();
$projectId = 56; // Integer | ID of the Project
$reportType = reportType_example; // String | Report Type
$authorization = authorization_example; // String | Bearer JWT Token
$otherProjectId = 56; // Integer | Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true.

try {
    $result = $api_instance->generateReport1($projectId, $reportType, $authorization, $otherProjectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedAPIsApi->generateReport1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedAPIsApi;

my $api_instance = WWW::SwaggerClient::DeprecatedAPIsApi->new();
my $projectId = 56; # Integer | ID of the Project
my $reportType = reportType_example; # String | Report Type
my $authorization = authorization_example; # String | Bearer JWT Token
my $otherProjectId = 56; # Integer | Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true.

eval { 
    my $result = $api_instance->generateReport1(projectId => $projectId, reportType => $reportType, authorization => $authorization, otherProjectId => $otherProjectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedAPIsApi->generateReport1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DeprecatedAPIsApi()
projectId = 56 # Integer | ID of the Project
reportType = reportType_example # String | Report Type
authorization = authorization_example # String | Bearer JWT Token (default to )
otherProjectId = 56 # Integer | Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true. (optional)

try: 
    # Generate Report
    api_response = api_instance.generate_report1(projectId, reportType, authorization, otherProjectId=otherProjectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedAPIsApi->generateReport1: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
reportType*
String
Report Type
Required
otherProjectId
Integer (int32)
Project Id of the secondary project to be included in the report. This parameter is required, if the enableProjectPicker property for this report type is set to true.

Responses

Status: 200 - OK

Status: 400 - Bad request: No project with id x


importProjectData

Import Project Data

Imports project data for a given projectId. Only Project Owner and Analyst can Import Project Data into a private project. Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL When calling this API from a REST client, you need to run curl as follows curl -X POST "http://HOST:PORT/codeinsight/api/importer/importProjectData?projectId=PROJECT_ID&checkInventory=false&checkReviewed=false&createEmptyInventory=false&overwriteInventoryNotes=true" -H "accept: application/json" -H "Authorization: Bearer JWT_TOKEN" -H "content-type: application/octet-stream" --data-binary "@path/filename.zip" Since this is deprecated, you can find the new api under projects api i.e., /projects/{projectId}/import


/importer/importProjectData

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//importer/importProjectData?projectId=&checkInventory=&checkReviewed=&createEmptyInventory=&overwriteInventoryNotes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeprecatedAPIsApi;

import java.io.File;
import java.util.*;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        Integer projectId = 56; // Integer | ID of the Project
        InputStream project data = ; // InputStream | Project data to import
        String authorization = authorization_example; // String | Bearer JWT Token
        String checkInventory = checkInventory_example; // String | Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory.
        String checkReviewed = checkReviewed_example; // String | Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed.
        String createEmptyInventory = createEmptyInventory_example; // String | Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false. 
        String overwriteInventoryNotes = overwriteInventoryNotes_example; // String | Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones.
        try {
            'String' result = apiInstance.importProjectData(projectId, project data, authorization, checkInventory, checkReviewed, createEmptyInventory, overwriteInventoryNotes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#importProjectData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeprecatedAPIsApi;

public class DeprecatedAPIsApiExample {

    public static void main(String[] args) {
        DeprecatedAPIsApi apiInstance = new DeprecatedAPIsApi();
        Integer projectId = 56; // Integer | ID of the Project
        InputStream project data = ; // InputStream | Project data to import
        String authorization = authorization_example; // String | Bearer JWT Token
        String checkInventory = checkInventory_example; // String | Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory.
        String checkReviewed = checkReviewed_example; // String | Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed.
        String createEmptyInventory = createEmptyInventory_example; // String | Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false. 
        String overwriteInventoryNotes = overwriteInventoryNotes_example; // String | Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones.
        try {
            'String' result = apiInstance.importProjectData(projectId, project data, authorization, checkInventory, checkReviewed, createEmptyInventory, overwriteInventoryNotes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeprecatedAPIsApi#importProjectData");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
InputStream *project data = ; // Project data to import
String *authorization = authorization_example; // Bearer JWT Token (default to )
String *checkInventory = checkInventory_example; // Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory. (optional)
String *checkReviewed = checkReviewed_example; // Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed. (optional)
String *createEmptyInventory = createEmptyInventory_example; // Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false.  (optional)
String *overwriteInventoryNotes = overwriteInventoryNotes_example; // Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones. (optional)

DeprecatedAPIsApi *apiInstance = [[DeprecatedAPIsApi alloc] init];

// Import Project Data
[apiInstance importProjectDataWith:projectId
    project data:project data
    authorization:authorization
    checkInventory:checkInventory
    checkReviewed:checkReviewed
    createEmptyInventory:createEmptyInventory
    overwriteInventoryNotes:overwriteInventoryNotes
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.DeprecatedAPIsApi()

var projectId = 56; // {Integer} ID of the Project

var project data = ; // {InputStream} Project data to import

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'checkInventory': checkInventory_example, // {String} Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory.
  'checkReviewed': checkReviewed_example, // {String} Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed.
  'createEmptyInventory': createEmptyInventory_example, // {String} Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false. 
  'overwriteInventoryNotes': overwriteInventoryNotes_example // {String} Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importProjectData(projectId, project data, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class importProjectDataExample
    {
        public void main()
        {
            
            var apiInstance = new DeprecatedAPIsApi();
            var projectId = 56;  // Integer | ID of the Project
            var project data = new InputStream(); // InputStream | Project data to import
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var checkInventory = checkInventory_example;  // String | Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory. (optional) 
            var checkReviewed = checkReviewed_example;  // String | Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed. (optional) 
            var createEmptyInventory = createEmptyInventory_example;  // String | Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false.  (optional) 
            var overwriteInventoryNotes = overwriteInventoryNotes_example;  // String | Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones. (optional) 

            try
            {
                // Import Project Data
                'String' result = apiInstance.importProjectData(projectId, project data, authorization, checkInventory, checkReviewed, createEmptyInventory, overwriteInventoryNotes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeprecatedAPIsApi.importProjectData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DeprecatedAPIsApi();
$projectId = 56; // Integer | ID of the Project
$project data = ; // InputStream | Project data to import
$authorization = authorization_example; // String | Bearer JWT Token
$checkInventory = checkInventory_example; // String | Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory.
$checkReviewed = checkReviewed_example; // String | Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed.
$createEmptyInventory = createEmptyInventory_example; // String | Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false. 
$overwriteInventoryNotes = overwriteInventoryNotes_example; // String | Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones.

try {
    $result = $api_instance->importProjectData($projectId, $project data, $authorization, $checkInventory, $checkReviewed, $createEmptyInventory, $overwriteInventoryNotes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeprecatedAPIsApi->importProjectData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DeprecatedAPIsApi;

my $api_instance = WWW::SwaggerClient::DeprecatedAPIsApi->new();
my $projectId = 56; # Integer | ID of the Project
my $project data = WWW::SwaggerClient::Object::InputStream->new(); # InputStream | Project data to import
my $authorization = authorization_example; # String | Bearer JWT Token
my $checkInventory = checkInventory_example; # String | Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory.
my $checkReviewed = checkReviewed_example; # String | Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed.
my $createEmptyInventory = createEmptyInventory_example; # String | Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false. 
my $overwriteInventoryNotes = overwriteInventoryNotes_example; # String | Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones.

eval { 
    my $result = $api_instance->importProjectData(projectId => $projectId, project data => $project data, authorization => $authorization, checkInventory => $checkInventory, checkReviewed => $checkReviewed, createEmptyInventory => $createEmptyInventory, overwriteInventoryNotes => $overwriteInventoryNotes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeprecatedAPIsApi->importProjectData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DeprecatedAPIsApi()
projectId = 56 # Integer | ID of the Project
project data =  # InputStream | Project data to import
authorization = authorization_example # String | Bearer JWT Token (default to )
checkInventory = checkInventory_example # String | Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory. (optional)
checkReviewed = checkReviewed_example # String | Check file MD5 for review.  If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed. (optional)
createEmptyInventory = createEmptyInventory_example # String | Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false.  (optional)
overwriteInventoryNotes = overwriteInventoryNotes_example # String | Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones. (optional)

try: 
    # Import Project Data
    api_response = api_instance.import_project_data(projectId, project data, authorization, checkInventory=checkInventory, checkReviewed=checkReviewed, createEmptyInventory=createEmptyInventory, overwriteInventoryNotes=overwriteInventoryNotes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeprecatedAPIsApi->importProjectData: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
project data *
Query parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
checkInventory
String
Check file MD5 for inventory. If enabled, only files with matching MD5 in the import data file and the scanned file will be associated to inventory.
checkReviewed
String
Check file MD5 for review. If enabled, only files with matching MD5 in the import data file and the scanned file will be marked as reviewed.
createEmptyInventory
String
Create inventory even if no matching file is found. By default value of this parameter is retrieved from the Project Setting(On data import or rescan, delete inventory with no associated files). If you wish to override the project setting you can pass true or false.
overwriteInventoryNotes
String
Choose to overwrite or append inventory notes (Audit Notes, Notices Text, Usage Guidance, Remediation Notes). By default notes will be overwritten if the inventory is same. If set to false, notes will be appended to existing ones.

Responses

Status: 200 - OK


Files

getFileDetails

Get details of a file by Id

Get file details of a given fileId. If the remote flag is true, it'll fetch the corresponding remote file info, otherwise by default the flag is false and scanner file information will be shown.


/files/{fileId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//files/{fileId}?isRemote="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilesApi;

import java.io.File;
import java.util.*;

public class FilesApiExample {

    public static void main(String[] args) {
        
        FilesApi apiInstance = new FilesApi();
        Integer fileId = 56; // Integer | ID of the File
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean isRemote = true; // Boolean | if true, fetch results of corresponding remote file
        try {
            apiInstance.getFileDetails(fileId, authorization, isRemote);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getFileDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilesApi;

public class FilesApiExample {

    public static void main(String[] args) {
        FilesApi apiInstance = new FilesApi();
        Integer fileId = 56; // Integer | ID of the File
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean isRemote = true; // Boolean | if true, fetch results of corresponding remote file
        try {
            apiInstance.getFileDetails(fileId, authorization, isRemote);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilesApi#getFileDetails");
            e.printStackTrace();
        }
    }
}
Integer *fileId = 56; // ID of the File
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *isRemote = true; // if true, fetch results of corresponding remote file (optional) (default to false)

FilesApi *apiInstance = [[FilesApi alloc] init];

// Get details of a file by Id
[apiInstance getFileDetailsWith:fileId
    authorization:authorization
    isRemote:isRemote
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.FilesApi()

var fileId = 56; // {Integer} ID of the File

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'isRemote': true // {Boolean} if true, fetch results of corresponding remote file
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getFileDetails(fileId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFileDetailsExample
    {
        public void main()
        {
            
            var apiInstance = new FilesApi();
            var fileId = 56;  // Integer | ID of the File
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var isRemote = true;  // Boolean | if true, fetch results of corresponding remote file (optional)  (default to false)

            try
            {
                // Get details of a file by Id
                apiInstance.getFileDetails(fileId, authorization, isRemote);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilesApi.getFileDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FilesApi();
$fileId = 56; // Integer | ID of the File
$authorization = authorization_example; // String | Bearer JWT Token
$isRemote = true; // Boolean | if true, fetch results of corresponding remote file

try {
    $api_instance->getFileDetails($fileId, $authorization, $isRemote);
} catch (Exception $e) {
    echo 'Exception when calling FilesApi->getFileDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilesApi;

my $api_instance = WWW::SwaggerClient::FilesApi->new();
my $fileId = 56; # Integer | ID of the File
my $authorization = authorization_example; # String | Bearer JWT Token
my $isRemote = true; # Boolean | if true, fetch results of corresponding remote file

eval { 
    $api_instance->getFileDetails(fileId => $fileId, authorization => $authorization, isRemote => $isRemote);
};
if ($@) {
    warn "Exception when calling FilesApi->getFileDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FilesApi()
fileId = 56 # Integer | ID of the File
authorization = authorization_example # String | Bearer JWT Token (default to )
isRemote = true # Boolean | if true, fetch results of corresponding remote file (optional) (default to false)

try: 
    # Get details of a file by Id
    api_instance.get_file_details(fileId, authorization, isRemote=isRemote)
except ApiException as e:
    print("Exception when calling FilesApi->getFileDetails: %s\n" % e)

Parameters

Path parameters
Name Description
fileId*
Integer (int32)
ID of the File
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
isRemote
Boolean
if true, fetch results of corresponding remote file

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


Folder

createFolder

Create Folder

Creates a folder for the given name and returns folderId with success message.


/folders

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//folders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FolderApi;

import java.io.File;
import java.util.*;

public class FolderApiExample {

    public static void main(String[] args) {
        
        FolderApi apiInstance = new FolderApi();
        FolderModel body = ; // FolderModel | To create a folder, folderName is required and parentFolderId is optional. 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createFolder(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#createFolder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FolderApi;

public class FolderApiExample {

    public static void main(String[] args) {
        FolderApi apiInstance = new FolderApi();
        FolderModel body = ; // FolderModel | To create a folder, folderName is required and parentFolderId is optional. 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createFolder(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#createFolder");
            e.printStackTrace();
        }
    }
}
FolderModel *body = ; // To create a folder, folderName is required and parentFolderId is optional. 
String *authorization = authorization_example; // Bearer JWT Token (default to )

FolderApi *apiInstance = [[FolderApi alloc] init];

// Create Folder
[apiInstance createFolderWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.FolderApi()

var body = ; // {FolderModel} To create a folder, folderName is required and parentFolderId is optional. 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createFolder(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFolderExample
    {
        public void main()
        {
            
            var apiInstance = new FolderApi();
            var body = new FolderModel(); // FolderModel | To create a folder, folderName is required and parentFolderId is optional. 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create Folder
                apiInstance.createFolder(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FolderApi.createFolder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FolderApi();
$body = ; // FolderModel | To create a folder, folderName is required and parentFolderId is optional. 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createFolder($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->createFolder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FolderApi;

my $api_instance = WWW::SwaggerClient::FolderApi->new();
my $body = WWW::SwaggerClient::Object::FolderModel->new(); # FolderModel | To create a folder, folderName is required and parentFolderId is optional. 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createFolder(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling FolderApi->createFolder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FolderApi()
body =  # FolderModel | To create a folder, folderName is required and parentFolderId is optional. 
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create Folder
    api_instance.create_folder(body, authorization)
except ApiException as e:
    print("Exception when calling FolderApi->createFolder: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteFolder

Delete a folder

Deleting a folder will delete all subfolders, contained projects will be associated wih the parent folder(Projects(0)).


/folders/{folderId}

Usage and SDK Samples

curl -X DELETE "http://localhost/codeinsight/api//folders/{folderId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FolderApi;

import java.io.File;
import java.util.*;

public class FolderApiExample {

    public static void main(String[] args) {
        
        FolderApi apiInstance = new FolderApi();
        Integer folderId = 56; // Integer | ID of the folder
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteFolder(folderId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#deleteFolder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FolderApi;

public class FolderApiExample {

    public static void main(String[] args) {
        FolderApi apiInstance = new FolderApi();
        Integer folderId = 56; // Integer | ID of the folder
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteFolder(folderId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#deleteFolder");
            e.printStackTrace();
        }
    }
}
Integer *folderId = 56; // ID of the folder
String *authorization = authorization_example; // Bearer JWT Token (default to )

FolderApi *apiInstance = [[FolderApi alloc] init];

// Delete a folder
[apiInstance deleteFolderWith:folderId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.FolderApi()

var folderId = 56; // {Integer} ID of the folder

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteFolder(folderId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFolderExample
    {
        public void main()
        {
            
            var apiInstance = new FolderApi();
            var folderId = 56;  // Integer | ID of the folder
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Delete a folder
                apiInstance.deleteFolder(folderId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FolderApi.deleteFolder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FolderApi();
$folderId = 56; // Integer | ID of the folder
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->deleteFolder($folderId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->deleteFolder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FolderApi;

my $api_instance = WWW::SwaggerClient::FolderApi->new();
my $folderId = 56; # Integer | ID of the folder
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->deleteFolder(folderId => $folderId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling FolderApi->deleteFolder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FolderApi()
folderId = 56 # Integer | ID of the folder
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Delete a folder
    api_instance.delete_folder(folderId, authorization)
except ApiException as e:
    print("Exception when calling FolderApi->deleteFolder: %s\n" % e)

Parameters

Path parameters
Name Description
folderId*
Integer (int32)
ID of the folder
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getFolder

Get Folder By Id

Get existing folder by folderId


/folders/{folderId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//folders/{folderId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FolderApi;

import java.io.File;
import java.util.*;

public class FolderApiExample {

    public static void main(String[] args) {
        
        FolderApi apiInstance = new FolderApi();
        Integer folderId = 56; // Integer | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getFolder(folderId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#getFolder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FolderApi;

public class FolderApiExample {

    public static void main(String[] args) {
        FolderApi apiInstance = new FolderApi();
        Integer folderId = 56; // Integer | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getFolder(folderId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#getFolder");
            e.printStackTrace();
        }
    }
}
Integer *folderId = 56; // 
String *authorization = authorization_example; // Bearer JWT Token (default to )

FolderApi *apiInstance = [[FolderApi alloc] init];

// Get Folder By Id
[apiInstance getFolderWith:folderId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.FolderApi()

var folderId = 56; // {Integer} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getFolder(folderId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFolderExample
    {
        public void main()
        {
            
            var apiInstance = new FolderApi();
            var folderId = 56;  // Integer | 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Folder By Id
                apiInstance.getFolder(folderId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FolderApi.getFolder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FolderApi();
$folderId = 56; // Integer | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getFolder($folderId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->getFolder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FolderApi;

my $api_instance = WWW::SwaggerClient::FolderApi->new();
my $folderId = 56; # Integer | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getFolder(folderId => $folderId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling FolderApi->getFolder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FolderApi()
folderId = 56 # Integer | 
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Folder By Id
    api_instance.get_folder(folderId, authorization)
except ApiException as e:
    print("Exception when calling FolderApi->getFolder: %s\n" % e)

Parameters

Path parameters
Name Description
folderId*
Integer (int32)
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


searchFolders

Get folders based on the name provided

Return folders based on the name provided


/folders/search

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//folders/search?folderName=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FolderApi;

import java.io.File;
import java.util.*;

public class FolderApiExample {

    public static void main(String[] args) {
        
        FolderApi apiInstance = new FolderApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        String folderName = folderName_example; // String | Search happens based on the name given 
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number of records to fetch
        try {
            apiInstance.searchFolders(authorization, folderName, offset, limit);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#searchFolders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FolderApi;

public class FolderApiExample {

    public static void main(String[] args) {
        FolderApi apiInstance = new FolderApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        String folderName = folderName_example; // String | Search happens based on the name given 
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number of records to fetch
        try {
            apiInstance.searchFolders(authorization, folderName, offset, limit);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#searchFolders");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer JWT Token (default to )
String *folderName = folderName_example; // Search happens based on the name given  (optional)
Integer *offset = 56; // Index of the page to start with (optional) (default to 1)
Integer *limit = 56; // Number of records to fetch (optional) (default to 25)

FolderApi *apiInstance = [[FolderApi alloc] init];

// Get folders based on the name provided
[apiInstance searchFoldersWith:authorization
    folderName:folderName
    offset:offset
    limit:limit
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.FolderApi()

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'folderName': folderName_example, // {String} Search happens based on the name given 
  'offset': 56, // {Integer} Index of the page to start with
  'limit': 56 // {Integer} Number of records to fetch
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchFolders(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchFoldersExample
    {
        public void main()
        {
            
            var apiInstance = new FolderApi();
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var folderName = folderName_example;  // String | Search happens based on the name given  (optional) 
            var offset = 56;  // Integer | Index of the page to start with (optional)  (default to 1)
            var limit = 56;  // Integer | Number of records to fetch (optional)  (default to 25)

            try
            {
                // Get folders based on the name provided
                apiInstance.searchFolders(authorization, folderName, offset, limit);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FolderApi.searchFolders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FolderApi();
$authorization = authorization_example; // String | Bearer JWT Token
$folderName = folderName_example; // String | Search happens based on the name given 
$offset = 56; // Integer | Index of the page to start with
$limit = 56; // Integer | Number of records to fetch

try {
    $api_instance->searchFolders($authorization, $folderName, $offset, $limit);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->searchFolders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FolderApi;

my $api_instance = WWW::SwaggerClient::FolderApi->new();
my $authorization = authorization_example; # String | Bearer JWT Token
my $folderName = folderName_example; # String | Search happens based on the name given 
my $offset = 56; # Integer | Index of the page to start with
my $limit = 56; # Integer | Number of records to fetch

eval { 
    $api_instance->searchFolders(authorization => $authorization, folderName => $folderName, offset => $offset, limit => $limit);
};
if ($@) {
    warn "Exception when calling FolderApi->searchFolders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FolderApi()
authorization = authorization_example # String | Bearer JWT Token (default to )
folderName = folderName_example # String | Search happens based on the name given  (optional)
offset = 56 # Integer | Index of the page to start with (optional) (default to 1)
limit = 56 # Integer | Number of records to fetch (optional) (default to 25)

try: 
    # Get folders based on the name provided
    api_instance.search_folders(authorization, folderName=folderName, offset=offset, limit=limit)
except ApiException as e:
    print("Exception when calling FolderApi->searchFolders: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
folderName
String
Search happens based on the name given
offset
Integer (int32)
Index of the page to start with
limit
Integer (int32)
Number of records to fetch

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


updateFolder

Update folder details

Update folder details for the given folderId.


/folders/{folderId}

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//folders/{folderId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FolderApi;

import java.io.File;
import java.util.*;

public class FolderApiExample {

    public static void main(String[] args) {
        
        FolderApi apiInstance = new FolderApi();
        Integer folderId = 56; // Integer | 
        FolderModel body = ; // FolderModel | Update details of a folder.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateFolder(folderId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#updateFolder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FolderApi;

public class FolderApiExample {

    public static void main(String[] args) {
        FolderApi apiInstance = new FolderApi();
        Integer folderId = 56; // Integer | 
        FolderModel body = ; // FolderModel | Update details of a folder.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateFolder(folderId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling FolderApi#updateFolder");
            e.printStackTrace();
        }
    }
}
Integer *folderId = 56; // 
FolderModel *body = ; // Update details of a folder.
String *authorization = authorization_example; // Bearer JWT Token (default to )

FolderApi *apiInstance = [[FolderApi alloc] init];

// Update folder details
[apiInstance updateFolderWith:folderId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.FolderApi()

var folderId = 56; // {Integer} 

var body = ; // {FolderModel} Update details of a folder.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateFolder(folderId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateFolderExample
    {
        public void main()
        {
            
            var apiInstance = new FolderApi();
            var folderId = 56;  // Integer | 
            var body = new FolderModel(); // FolderModel | Update details of a folder.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Update folder details
                apiInstance.updateFolder(folderId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FolderApi.updateFolder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\FolderApi();
$folderId = 56; // Integer | 
$body = ; // FolderModel | Update details of a folder.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateFolder($folderId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling FolderApi->updateFolder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FolderApi;

my $api_instance = WWW::SwaggerClient::FolderApi->new();
my $folderId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::FolderModel->new(); # FolderModel | Update details of a folder.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateFolder(folderId => $folderId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling FolderApi->updateFolder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.FolderApi()
folderId = 56 # Integer | 
body =  # FolderModel | Update details of a folder.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Update folder details
    api_instance.update_folder(folderId, body, authorization)
except ApiException as e:
    print("Exception when calling FolderApi->updateFolder: %s\n" % e)

Parameters

Path parameters
Name Description
folderId*
Integer (int32)
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


InventoryAPI

addFilesToInventory

Add Files and/or Folders to Inventory

Add files and/or folders to inventory item and returns the response message


/inventories/{inventoryId}/files

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//inventories/{inventoryId}/files"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        InventoryFilesModel body = ; // InventoryFilesModel | To Add files and folders to the inventory provide file and folder paths.
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            Json result = apiInstance.addFilesToInventory(body, inventoryId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#addFilesToInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        InventoryFilesModel body = ; // InventoryFilesModel | To Add files and folders to the inventory provide file and folder paths.
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            Json result = apiInstance.addFilesToInventory(body, inventoryId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#addFilesToInventory");
            e.printStackTrace();
        }
    }
}
InventoryFilesModel *body = ; // To Add files and folders to the inventory provide file and folder paths.
Integer *inventoryId = 56; // ID of the Inventory
String *authorization = authorization_example; // Bearer JWT Token (default to )

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// Add Files and/or Folders to Inventory
[apiInstance addFilesToInventoryWith:body
    inventoryId:inventoryId
    authorization:authorization
              completionHandler: ^(Json output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var body = ; // {InventoryFilesModel} To Add files and folders to the inventory provide file and folder paths.

var inventoryId = 56; // {Integer} ID of the Inventory

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addFilesToInventory(body, inventoryId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addFilesToInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var body = new InventoryFilesModel(); // InventoryFilesModel | To Add files and folders to the inventory provide file and folder paths.
            var inventoryId = 56;  // Integer | ID of the Inventory
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Add Files and/or Folders to Inventory
                Json result = apiInstance.addFilesToInventory(body, inventoryId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.addFilesToInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$body = ; // InventoryFilesModel | To Add files and folders to the inventory provide file and folder paths.
$inventoryId = 56; // Integer | ID of the Inventory
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->addFilesToInventory($body, $inventoryId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->addFilesToInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $body = WWW::SwaggerClient::Object::InventoryFilesModel->new(); # InventoryFilesModel | To Add files and folders to the inventory provide file and folder paths.
my $inventoryId = 56; # Integer | ID of the Inventory
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->addFilesToInventory(body => $body, inventoryId => $inventoryId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->addFilesToInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
body =  # InventoryFilesModel | To Add files and folders to the inventory provide file and folder paths.
inventoryId = 56 # Integer | ID of the Inventory
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Add Files and/or Folders to Inventory
    api_response = api_instance.add_files_to_inventory(body, inventoryId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->addFilesToInventory: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


createInventory

create Inventory

create an inventory. Name and Inventory type is a mandatory field.


/inventories

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//inventories"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        ProjectInventoryModel body = ; // ProjectInventoryModel | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createInventory(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#createInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        ProjectInventoryModel body = ; // ProjectInventoryModel | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createInventory(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#createInventory");
            e.printStackTrace();
        }
    }
}
ProjectInventoryModel *body = ; // 
String *authorization = authorization_example; //  (default to )

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// create Inventory
[apiInstance createInventoryWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var body = ; // {ProjectInventoryModel} 

var authorization = authorization_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createInventory(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var body = new ProjectInventoryModel(); // ProjectInventoryModel | 
            var authorization = authorization_example;  // String |  (default to )

            try
            {
                // create Inventory
                apiInstance.createInventory(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.createInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$body = ; // ProjectInventoryModel | 
$authorization = authorization_example; // String | 

try {
    $api_instance->createInventory($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->createInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $body = WWW::SwaggerClient::Object::ProjectInventoryModel->new(); # ProjectInventoryModel | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->createInventory(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->createInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
body =  # ProjectInventoryModel | 
authorization = authorization_example # String |  (default to )

try: 
    # create Inventory
    api_instance.create_inventory(body, authorization)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->createInventory: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteInventory

Delete the inventory

delete inventory


/inventories/{inventoryId}

Usage and SDK Samples

curl -X DELETE "http://localhost/codeinsight/api//inventories/{inventoryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteInventory(inventoryId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#deleteInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteInventory(inventoryId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#deleteInventory");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
String *authorization = authorization_example; // Bearer JWT Token (default to )

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// Delete the inventory
[apiInstance deleteInventoryWith:inventoryId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteInventory(inventoryId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Delete the inventory
                apiInstance.deleteInventory(inventoryId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.deleteInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$inventoryId = 56; // Integer | ID of the Inventory
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->deleteInventory($inventoryId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->deleteInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->deleteInventory(inventoryId => $inventoryId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->deleteInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
inventoryId = 56 # Integer | ID of the Inventory
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Delete the inventory
    api_instance.delete_inventory(inventoryId, authorization)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->deleteInventory: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getInventory

Get the inventories of file/folder ids

Returns the inventories file and/or folder ids


/inventories/search

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//inventories/search?projectId=&fileIds=&folderIds=&published=&limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        String fileIds = fileIds_example; // String | Provide list of file ids
        String folderIds = folderIds_example; // String | Provide list of folder ids
        String published = published_example; // String | If true, then only published inventory items are returned; if false, then only un-published inventory items are returned
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            Json result = apiInstance.getInventory(projectId, authorization, fileIds, folderIds, published, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#getInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        String fileIds = fileIds_example; // String | Provide list of file ids
        String folderIds = folderIds_example; // String | Provide list of folder ids
        String published = published_example; // String | If true, then only published inventory items are returned; if false, then only un-published inventory items are returned
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            Json result = apiInstance.getInventory(projectId, authorization, fileIds, folderIds, published, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#getInventory");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )
String *fileIds = fileIds_example; // Provide list of file ids (optional)
String *folderIds = folderIds_example; // Provide list of folder ids (optional)
String *published = published_example; // If true, then only published inventory items are returned; if false, then only un-published inventory items are returned (optional)
Integer *limit = 56; // Page Size. Number Of Records to fetch per page (optional) (default to 25)
Integer *offset = 56; // Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// Get the inventories of file/folder ids
[apiInstance getInventoryWith:projectId
    authorization:authorization
    fileIds:fileIds
    folderIds:folderIds
    published:published
    limit:limit
    offset:offset
              completionHandler: ^(Json output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'fileIds': fileIds_example, // {String} Provide list of file ids
  'folderIds': folderIds_example, // {String} Provide list of folder ids
  'published': published_example, // {String} If true, then only published inventory items are returned; if false, then only un-published inventory items are returned
  'limit': 56, // {Integer} Page Size. Number Of Records to fetch per page
  'offset': 56 // {Integer} Page Number. Index of the page to start with(starts from 1)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInventory(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var fileIds = fileIds_example;  // String | Provide list of file ids (optional) 
            var folderIds = folderIds_example;  // String | Provide list of folder ids (optional) 
            var published = published_example;  // String | If true, then only published inventory items are returned; if false, then only un-published inventory items are returned (optional) 
            var limit = 56;  // Integer | Page Size. Number Of Records to fetch per page (optional)  (default to 25)
            var offset = 56;  // Integer | Page Number. Index of the page to start with(starts from 1) (optional)  (default to 1)

            try
            {
                // Get the inventories of file/folder ids
                Json result = apiInstance.getInventory(projectId, authorization, fileIds, folderIds, published, limit, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.getInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token
$fileIds = fileIds_example; // String | Provide list of file ids
$folderIds = folderIds_example; // String | Provide list of folder ids
$published = published_example; // String | If true, then only published inventory items are returned; if false, then only un-published inventory items are returned
$limit = 56; // Integer | Page Size. Number Of Records to fetch per page
$offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)

try {
    $result = $api_instance->getInventory($projectId, $authorization, $fileIds, $folderIds, $published, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->getInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token
my $fileIds = fileIds_example; # String | Provide list of file ids
my $folderIds = folderIds_example; # String | Provide list of folder ids
my $published = published_example; # String | If true, then only published inventory items are returned; if false, then only un-published inventory items are returned
my $limit = 56; # Integer | Page Size. Number Of Records to fetch per page
my $offset = 56; # Integer | Page Number. Index of the page to start with(starts from 1)

eval { 
    my $result = $api_instance->getInventory(projectId => $projectId, authorization => $authorization, fileIds => $fileIds, folderIds => $folderIds, published => $published, limit => $limit, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->getInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )
fileIds = fileIds_example # String | Provide list of file ids (optional)
folderIds = folderIds_example # String | Provide list of folder ids (optional)
published = published_example # String | If true, then only published inventory items are returned; if false, then only un-published inventory items are returned (optional)
limit = 56 # Integer | Page Size. Number Of Records to fetch per page (optional) (default to 25)
offset = 56 # Integer | Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)

try: 
    # Get the inventories of file/folder ids
    api_response = api_instance.get_inventory(projectId, authorization, fileIds=fileIds, folderIds=folderIds, published=published, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->getInventory: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
fileIds
String
Provide list of file ids
folderIds
String
Provide list of folder ids
published
String
If true, then only published inventory items are returned; if false, then only un-published inventory items are returned
limit
Integer (int32)
Page Size. Number Of Records to fetch per page
offset
Integer (int32)
Page Number. Index of the page to start with(starts from 1)

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getInventoryById

Get details of an inventory

Get details of an inventory.


/inventories/{inventoryId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//inventories/{inventoryId}?skipVulnerabilities="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean skipVulnerabilities = true; // Boolean | If true , hide vulnerabilty details
        try {
            apiInstance.getInventoryById(inventoryId, authorization, skipVulnerabilities);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#getInventoryById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean skipVulnerabilities = true; // Boolean | If true , hide vulnerabilty details
        try {
            apiInstance.getInventoryById(inventoryId, authorization, skipVulnerabilities);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#getInventoryById");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *skipVulnerabilities = true; // If true , hide vulnerabilty details (optional) (default to false)

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// Get details of an inventory
[apiInstance getInventoryByIdWith:inventoryId
    authorization:authorization
    skipVulnerabilities:skipVulnerabilities
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'skipVulnerabilities': true // {Boolean} If true , hide vulnerabilty details
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getInventoryById(inventoryId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInventoryByIdExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var skipVulnerabilities = true;  // Boolean | If true , hide vulnerabilty details (optional)  (default to false)

            try
            {
                // Get details of an inventory
                apiInstance.getInventoryById(inventoryId, authorization, skipVulnerabilities);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.getInventoryById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$inventoryId = 56; // Integer | ID of the Inventory
$authorization = authorization_example; // String | Bearer JWT Token
$skipVulnerabilities = true; // Boolean | If true , hide vulnerabilty details

try {
    $api_instance->getInventoryById($inventoryId, $authorization, $skipVulnerabilities);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->getInventoryById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $authorization = authorization_example; # String | Bearer JWT Token
my $skipVulnerabilities = true; # Boolean | If true , hide vulnerabilty details

eval { 
    $api_instance->getInventoryById(inventoryId => $inventoryId, authorization => $authorization, skipVulnerabilities => $skipVulnerabilities);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->getInventoryById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
inventoryId = 56 # Integer | ID of the Inventory
authorization = authorization_example # String | Bearer JWT Token (default to )
skipVulnerabilities = true # Boolean | If true , hide vulnerabilty details (optional) (default to false)

try: 
    # Get details of an inventory
    api_instance.get_inventory_by_id(inventoryId, authorization, skipVulnerabilities=skipVulnerabilities)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->getInventoryById: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
skipVulnerabilities
Boolean
If true , hide vulnerabilty details

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getVulnerabilties

Get vulnerability details of an inventory

Get vulnerability details of an inventory.


/inventories/{inventoryId}/vulnerabilities

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//inventories/{inventoryId}/vulnerabilities?limit=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            apiInstance.getVulnerabilties(inventoryId, authorization, limit, offset);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#getVulnerabilties");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer limit = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        try {
            apiInstance.getVulnerabilties(inventoryId, authorization, limit, offset);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#getVulnerabilties");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *limit = 56; // Page Size. Number Of Records to fetch per page (optional) (default to 25)
Integer *offset = 56; // Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// Get vulnerability details of an inventory
[apiInstance getVulnerabiltiesWith:inventoryId
    authorization:authorization
    limit:limit
    offset:offset
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'limit': 56, // {Integer} Page Size. Number Of Records to fetch per page
  'offset': 56 // {Integer} Page Number. Index of the page to start with(starts from 1)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getVulnerabilties(inventoryId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVulnerabiltiesExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var limit = 56;  // Integer | Page Size. Number Of Records to fetch per page (optional)  (default to 25)
            var offset = 56;  // Integer | Page Number. Index of the page to start with(starts from 1) (optional)  (default to 1)

            try
            {
                // Get vulnerability details of an inventory
                apiInstance.getVulnerabilties(inventoryId, authorization, limit, offset);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.getVulnerabilties: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$inventoryId = 56; // Integer | ID of the Inventory
$authorization = authorization_example; // String | Bearer JWT Token
$limit = 56; // Integer | Page Size. Number Of Records to fetch per page
$offset = 56; // Integer | Page Number. Index of the page to start with(starts from 1)

try {
    $api_instance->getVulnerabilties($inventoryId, $authorization, $limit, $offset);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->getVulnerabilties: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $authorization = authorization_example; # String | Bearer JWT Token
my $limit = 56; # Integer | Page Size. Number Of Records to fetch per page
my $offset = 56; # Integer | Page Number. Index of the page to start with(starts from 1)

eval { 
    $api_instance->getVulnerabilties(inventoryId => $inventoryId, authorization => $authorization, limit => $limit, offset => $offset);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->getVulnerabilties: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
inventoryId = 56 # Integer | ID of the Inventory
authorization = authorization_example # String | Bearer JWT Token (default to )
limit = 56 # Integer | Page Size. Number Of Records to fetch per page (optional) (default to 25)
offset = 56 # Integer | Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)

try: 
    # Get vulnerability details of an inventory
    api_instance.get_vulnerabilties(inventoryId, authorization, limit=limit, offset=offset)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->getVulnerabilties: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
limit
Integer (int32)
Page Size. Number Of Records to fetch per page
offset
Integer (int32)
Page Number. Index of the page to start with(starts from 1)

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


publishInventory

Publish Inventory

Publish an inventory for a given inventoryId


/inventories/{inventoryId}/publish

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//inventories/{inventoryId}/publish"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.publishInventory(inventoryId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#publishInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.publishInventory(inventoryId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#publishInventory");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
String *authorization = authorization_example; // Bearer JWT Token (default to )

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// Publish Inventory
[apiInstance publishInventoryWith:inventoryId
    authorization:authorization
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.publishInventory(inventoryId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class publishInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Publish Inventory
                'String' result = apiInstance.publishInventory(inventoryId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.publishInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$inventoryId = 56; // Integer | ID of the Inventory
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->publishInventory($inventoryId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->publishInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->publishInventory(inventoryId => $inventoryId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->publishInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
inventoryId = 56 # Integer | ID of the Inventory
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Publish Inventory
    api_response = api_instance.publish_inventory(inventoryId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->publishInventory: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


recallInventory

Recall Inventory

Recall an inventory for a given inventoryId


/inventories/{inventoryId}/recall

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//inventories/{inventoryId}/recall"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.recallInventory(inventoryId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#recallInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.recallInventory(inventoryId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#recallInventory");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
String *authorization = authorization_example; // Bearer JWT Token (default to )

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// Recall Inventory
[apiInstance recallInventoryWith:inventoryId
    authorization:authorization
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.recallInventory(inventoryId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class recallInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Recall Inventory
                'String' result = apiInstance.recallInventory(inventoryId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.recallInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$inventoryId = 56; // Integer | ID of the Inventory
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->recallInventory($inventoryId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->recallInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->recallInventory(inventoryId => $inventoryId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->recallInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
inventoryId = 56 # Integer | ID of the Inventory
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Recall Inventory
    api_response = api_instance.recall_inventory(inventoryId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->recallInventory: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


updateInventory

update Inventory

update an inventory for a given inventoryId.


/inventories/{inventoryId}

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//inventories/{inventoryId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        InventoryModel body = ; // InventoryModel | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateInventory(inventoryId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#updateInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        InventoryModel body = ; // InventoryModel | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateInventory(inventoryId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#updateInventory");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
InventoryModel *body = ; // 
String *authorization = authorization_example; // Bearer JWT Token (default to )

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// update Inventory
[apiInstance updateInventoryWith:inventoryId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var body = ; // {InventoryModel} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateInventory(inventoryId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var body = new InventoryModel(); // InventoryModel | 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // update Inventory
                apiInstance.updateInventory(inventoryId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.updateInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$inventoryId = 56; // Integer | ID of the Inventory
$body = ; // InventoryModel | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateInventory($inventoryId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->updateInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $body = WWW::SwaggerClient::Object::InventoryModel->new(); # InventoryModel | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateInventory(inventoryId => $inventoryId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->updateInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
inventoryId = 56 # Integer | ID of the Inventory
body =  # InventoryModel | 
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # update Inventory
    api_instance.update_inventory(inventoryId, body, authorization)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->updateInventory: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


updateInventoryStatus

inventory status

update an inventory status with DRAFT, APPROVED and REJECTED status.The approve/reject inventory affects Manual Review task only. Any changes made to Inventory will not affect Remediation and Miscellaneous tasks. On Approving Inventory, Inventory gets Approved and Manual review task will be closed with Approve status. On Rejecting Inventory, Inventory gets Rejected by creating an open Remediation task and the Manual review task will be closed with Reject status.


/inventories/{inventoryId}/status

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//inventories/{inventoryId}/status?status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryAPIApi;

import java.io.File;
import java.util.*;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String status = status_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateInventoryStatus(inventoryId, status, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#updateInventoryStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryAPIApi;

public class InventoryAPIApiExample {

    public static void main(String[] args) {
        InventoryAPIApi apiInstance = new InventoryAPIApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String status = status_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateInventoryStatus(inventoryId, status, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryAPIApi#updateInventoryStatus");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
String *status = status_example; //  (default to DRAFT)
String *authorization = authorization_example; // Bearer JWT Token (default to )

InventoryAPIApi *apiInstance = [[InventoryAPIApi alloc] init];

// inventory status
[apiInstance updateInventoryStatusWith:inventoryId
    status:status
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryAPIApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var status = status_example; // {String} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateInventoryStatus(inventoryId, status, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateInventoryStatusExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryAPIApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var status = status_example;  // String |  (default to DRAFT)
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // inventory status
                apiInstance.updateInventoryStatus(inventoryId, status, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryAPIApi.updateInventoryStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryAPIApi();
$inventoryId = 56; // Integer | ID of the Inventory
$status = status_example; // String | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateInventoryStatus($inventoryId, $status, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAPIApi->updateInventoryStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryAPIApi;

my $api_instance = WWW::SwaggerClient::InventoryAPIApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $status = status_example; # String | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateInventoryStatus(inventoryId => $inventoryId, status => $status, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling InventoryAPIApi->updateInventoryStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryAPIApi()
inventoryId = 56 # Integer | ID of the Inventory
status = status_example # String |  (default to DRAFT)
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # inventory status
    api_instance.update_inventory_status(inventoryId, status, authorization)
except ApiException as e:
    print("Exception when calling InventoryAPIApi->updateInventoryStatus: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
status*
String
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


InventoryWorkflow

createWorkflow

workflows

Create or update workflow for an inventory


/inventories/{inventoryId}/workflows

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//inventories/{inventoryId}/workflows"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryWorkflowApi;

import java.io.File;
import java.util.*;

public class InventoryWorkflowApiExample {

    public static void main(String[] args) {
        
        InventoryWorkflowApi apiInstance = new InventoryWorkflowApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        array[InventoryWorkflow] body = ; // array[InventoryWorkflow] | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createWorkflow(inventoryId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryWorkflowApi#createWorkflow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryWorkflowApi;

public class InventoryWorkflowApiExample {

    public static void main(String[] args) {
        InventoryWorkflowApi apiInstance = new InventoryWorkflowApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        array[InventoryWorkflow] body = ; // array[InventoryWorkflow] | 
        String authorization = authorization_example; // String | 
        try {
            apiInstance.createWorkflow(inventoryId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryWorkflowApi#createWorkflow");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
array[InventoryWorkflow] *body = ; // 
String *authorization = authorization_example; //  (default to )

InventoryWorkflowApi *apiInstance = [[InventoryWorkflowApi alloc] init];

// workflows
[apiInstance createWorkflowWith:inventoryId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryWorkflowApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var body = ; // {array[InventoryWorkflow]} 

var authorization = authorization_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createWorkflow(inventoryId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createWorkflowExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryWorkflowApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var body = new array[InventoryWorkflow](); // array[InventoryWorkflow] | 
            var authorization = authorization_example;  // String |  (default to )

            try
            {
                // workflows
                apiInstance.createWorkflow(inventoryId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryWorkflowApi.createWorkflow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryWorkflowApi();
$inventoryId = 56; // Integer | ID of the Inventory
$body = ; // array[InventoryWorkflow] | 
$authorization = authorization_example; // String | 

try {
    $api_instance->createWorkflow($inventoryId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling InventoryWorkflowApi->createWorkflow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryWorkflowApi;

my $api_instance = WWW::SwaggerClient::InventoryWorkflowApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $body = [WWW::SwaggerClient::Object::array[InventoryWorkflow]->new()]; # array[InventoryWorkflow] | 
my $authorization = authorization_example; # String | 

eval { 
    $api_instance->createWorkflow(inventoryId => $inventoryId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling InventoryWorkflowApi->createWorkflow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryWorkflowApi()
inventoryId = 56 # Integer | ID of the Inventory
body =  # array[InventoryWorkflow] | 
authorization = authorization_example # String |  (default to )

try: 
    # workflows
    api_instance.create_workflow(inventoryId, body, authorization)
except ApiException as e:
    print("Exception when calling InventoryWorkflowApi->createWorkflow: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getWorkflowByInventoryId

Get workflow details for an inventory

Get workflow details for an inventory


/inventories/{inventoryId}/workflows

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//inventories/{inventoryId}/workflows"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InventoryWorkflowApi;

import java.io.File;
import java.util.*;

public class InventoryWorkflowApiExample {

    public static void main(String[] args) {
        
        InventoryWorkflowApi apiInstance = new InventoryWorkflowApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getWorkflowByInventoryId(inventoryId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryWorkflowApi#getWorkflowByInventoryId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InventoryWorkflowApi;

public class InventoryWorkflowApiExample {

    public static void main(String[] args) {
        InventoryWorkflowApi apiInstance = new InventoryWorkflowApi();
        Integer inventoryId = 56; // Integer | ID of the Inventory
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getWorkflowByInventoryId(inventoryId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling InventoryWorkflowApi#getWorkflowByInventoryId");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the Inventory
String *authorization = authorization_example; // Bearer JWT Token (default to )

InventoryWorkflowApi *apiInstance = [[InventoryWorkflowApi alloc] init];

// Get workflow details for an inventory
[apiInstance getWorkflowByInventoryIdWith:inventoryId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.InventoryWorkflowApi()

var inventoryId = 56; // {Integer} ID of the Inventory

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getWorkflowByInventoryId(inventoryId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWorkflowByInventoryIdExample
    {
        public void main()
        {
            
            var apiInstance = new InventoryWorkflowApi();
            var inventoryId = 56;  // Integer | ID of the Inventory
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get workflow details for an inventory
                apiInstance.getWorkflowByInventoryId(inventoryId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InventoryWorkflowApi.getWorkflowByInventoryId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\InventoryWorkflowApi();
$inventoryId = 56; // Integer | ID of the Inventory
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getWorkflowByInventoryId($inventoryId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling InventoryWorkflowApi->getWorkflowByInventoryId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InventoryWorkflowApi;

my $api_instance = WWW::SwaggerClient::InventoryWorkflowApi->new();
my $inventoryId = 56; # Integer | ID of the Inventory
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getWorkflowByInventoryId(inventoryId => $inventoryId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling InventoryWorkflowApi->getWorkflowByInventoryId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.InventoryWorkflowApi()
inventoryId = 56 # Integer | ID of the Inventory
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get workflow details for an inventory
    api_instance.get_workflow_by_inventory_id(inventoryId, authorization)
except ApiException as e:
    print("Exception when calling InventoryWorkflowApi->getWorkflowByInventoryId: %s\n" % e)

Parameters

Path parameters
Name Description
inventoryId*
Integer (int32)
ID of the Inventory
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


License

createLicenses

Create a custom license

Creates a custom license


/licenses

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//licenses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LicenseApi;

import java.io.File;
import java.util.*;

public class LicenseApiExample {

    public static void main(String[] args) {
        
        LicenseApi apiInstance = new LicenseApi();
        LicenseModel body = ; // LicenseModel | To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createLicenses(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicenseApi#createLicenses");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LicenseApi;

public class LicenseApiExample {

    public static void main(String[] args) {
        LicenseApi apiInstance = new LicenseApi();
        LicenseModel body = ; // LicenseModel | To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createLicenses(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicenseApi#createLicenses");
            e.printStackTrace();
        }
    }
}
LicenseModel *body = ; // To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style
String *authorization = authorization_example; // Bearer JWT Token (default to )

LicenseApi *apiInstance = [[LicenseApi alloc] init];

// Create a custom license
[apiInstance createLicensesWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.LicenseApi()

var body = ; // {LicenseModel} To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createLicenses(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createLicensesExample
    {
        public void main()
        {
            
            var apiInstance = new LicenseApi();
            var body = new LicenseModel(); // LicenseModel | To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create a custom license
                apiInstance.createLicenses(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LicenseApi.createLicenses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LicenseApi();
$body = ; // LicenseModel | To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createLicenses($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling LicenseApi->createLicenses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LicenseApi;

my $api_instance = WWW::SwaggerClient::LicenseApi->new();
my $body = WWW::SwaggerClient::Object::LicenseModel->new(); # LicenseModel | To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createLicenses(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling LicenseApi->createLicenses: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
body =  # LicenseModel | To create a custom license the name, shortName and licenseText is required. 
Allowable values for familyName(Optional) are: 
 GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style |Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style |GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create a custom license
    api_instance.create_licenses(body, authorization)
except ApiException as e:
    print("Exception when calling LicenseApi->createLicenses: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 500 - Internal Server Error


licenseLookup

License Lookup

Returns id, name, priority, url, description, text, shortName and spdxIdentifier for a given license ID.


/license/lookup

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//license/lookup?licenseId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LicenseApi;

import java.io.File;
import java.util.*;

public class LicenseApiExample {

    public static void main(String[] args) {
        
        LicenseApi apiInstance = new LicenseApi();
        Long licenseId = 789; // Long | ID of the license
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            LicenseRestFormat result = apiInstance.licenseLookup(licenseId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicenseApi#licenseLookup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LicenseApi;

public class LicenseApiExample {

    public static void main(String[] args) {
        LicenseApi apiInstance = new LicenseApi();
        Long licenseId = 789; // Long | ID of the license
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            LicenseRestFormat result = apiInstance.licenseLookup(licenseId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LicenseApi#licenseLookup");
            e.printStackTrace();
        }
    }
}
Long *licenseId = 789; // ID of the license
String *authorization = authorization_example; // Bearer JWT Token (default to )

LicenseApi *apiInstance = [[LicenseApi alloc] init];

// License Lookup
[apiInstance licenseLookupWith:licenseId
    authorization:authorization
              completionHandler: ^(LicenseRestFormat output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.LicenseApi()

var licenseId = 789; // {Long} ID of the license

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.licenseLookup(licenseId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class licenseLookupExample
    {
        public void main()
        {
            
            var apiInstance = new LicenseApi();
            var licenseId = 789;  // Long | ID of the license
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // License Lookup
                LicenseRestFormat result = apiInstance.licenseLookup(licenseId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LicenseApi.licenseLookup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LicenseApi();
$licenseId = 789; // Long | ID of the license
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->licenseLookup($licenseId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LicenseApi->licenseLookup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LicenseApi;

my $api_instance = WWW::SwaggerClient::LicenseApi->new();
my $licenseId = 789; # Long | ID of the license
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->licenseLookup(licenseId => $licenseId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LicenseApi->licenseLookup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LicenseApi()
licenseId = 789 # Long | ID of the license
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # License Lookup
    api_response = api_instance.license_lookup(licenseId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LicenseApi->licenseLookup: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
licenseId*
Long (int64)
ID of the license
Required

Responses

Status: 200 - OK

Status: 400 - Bad request

Status: 500 - Internal Server Error


ProjectAPI

addChildProjects

Add child projects to parent project

Add child projects to parent project.


/projects/{projectId}/children

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//projects/{projectId}/children?childProjectIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | Id of Parent Project
        array[Integer] childProjectIds = ; // array[Integer] | Id of Child Projects
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.addChildProjects(projectId, childProjectIds, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#addChildProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | Id of Parent Project
        array[Integer] childProjectIds = ; // array[Integer] | Id of Child Projects
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.addChildProjects(projectId, childProjectIds, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#addChildProjects");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // Id of Parent Project
array[Integer] *childProjectIds = ; // Id of Child Projects
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Add child projects to parent project
[apiInstance addChildProjectsWith:projectId
    childProjectIds:childProjectIds
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} Id of Parent Project

var childProjectIds = ; // {array[Integer]} Id of Child Projects

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addChildProjects(projectId, childProjectIds, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addChildProjectsExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | Id of Parent Project
            var childProjectIds = new array[Integer](); // array[Integer] | Id of Child Projects
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Add child projects to parent project
                apiInstance.addChildProjects(projectId, childProjectIds, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.addChildProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | Id of Parent Project
$childProjectIds = ; // array[Integer] | Id of Child Projects
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->addChildProjects($projectId, $childProjectIds, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->addChildProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | Id of Parent Project
my $childProjectIds = []; # array[Integer] | Id of Child Projects
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->addChildProjects(projectId => $projectId, childProjectIds => $childProjectIds, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->addChildProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | Id of Parent Project
childProjectIds =  # array[Integer] | Id of Child Projects
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Add child projects to parent project
    api_instance.add_child_projects(projectId, childProjectIds, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->addChildProjects: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
Id of Parent Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
childProjectIds*
array[Integer] (int32)
Id of Child Projects
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


assignProjectRole

Assign Role

Assign a Users to a specific Project Role. Here "ownerId refers to the "contactId of the project.


/projects/{projectId}/users

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//projects/{projectId}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        ProjectRoleModel body = ; // ProjectRoleModel | Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.assignProjectRole(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#assignProjectRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        ProjectRoleModel body = ; // ProjectRoleModel | Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.assignProjectRole(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#assignProjectRole");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
ProjectRoleModel *body = ; // Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Assign Role
[apiInstance assignProjectRoleWith:projectId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var body = ; // {ProjectRoleModel} Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.assignProjectRole(projectId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assignProjectRoleExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var body = new ProjectRoleModel(); // ProjectRoleModel | Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Assign Role
                apiInstance.assignProjectRole(projectId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.assignProjectRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$body = ; // ProjectRoleModel | Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->assignProjectRole($projectId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->assignProjectRole: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $body = WWW::SwaggerClient::Object::ProjectRoleModel->new(); # ProjectRoleModel | Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->assignProjectRole(projectId => $projectId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->assignProjectRole: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
body =  # ProjectRoleModel | Add a Users to a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Assign Role
    api_instance.assign_project_role(projectId, body, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->assignProjectRole: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


createProject

Create Project

Creates a project for the given input and returns projectId with success message.


/projects

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        ProjectModel body = ; // ProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createProject(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#createProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        ProjectModel body = ; // ProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createProject(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#createProject");
            e.printStackTrace();
        }
    }
}
ProjectModel *body = ; // To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Create Project
[apiInstance createProjectWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var body = ; // {ProjectModel} To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createProject(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createProjectExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var body = new ProjectModel(); // ProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create Project
                apiInstance.createProject(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.createProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$body = ; // ProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createProject($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->createProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $body = WWW::SwaggerClient::Object::ProjectModel->new(); # ProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createProject(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->createProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
body =  # ProjectModel | To create a project the projectName field is required and other fields are optional. If the optional fields are left blank, the 'Project Default' values are applied for them.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create Project
    api_instance.create_project(body, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->createProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteProject

Delete a project

Deleting a project will delete all project inventory, corresponding notes and all code base files permanently from the server.


/projects/{projectId}

Usage and SDK Samples

curl -X DELETE "http://localhost/codeinsight/api//projects/{projectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteProject(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#deleteProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteProject(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#deleteProject");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Delete a project
[apiInstance deleteProjectWith:projectId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProject(projectId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteProjectExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Delete a project
                apiInstance.deleteProject(projectId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.deleteProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->deleteProject($projectId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->deleteProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->deleteProject(projectId => $projectId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->deleteProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Delete a project
    api_instance.delete_project(projectId, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->deleteProject: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


downloadReport

Download Report

Download Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For ALL Reports we need to provide the id of the report. All project users including Observer, Reviewer and Analyst can download reports for private projects. If a task is in progress the response will be 202 and the status will be provided in the header for e.g(ACTIVE, SCHEDULED). Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL. When calling this API from a REST client, you need to redirect output to a zip file as follows curl -X POST "http://HOST:PORT/codeinsight/api/projects/{projectId}/reports/{reportId}/download?taskId={taskId}" -H "accept: application/json" -H "Authorization: Bearer JWT_TOKEN" > report.zip


/projects/{projectId}/reports/{reportId}/download

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/reports/{reportId}/download?taskId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        Integer reportId = 56; // Integer | ID of the Report that is to be generated or downloaded
        Integer taskId = 56; // Integer | ID of the Report Task that is to be downloaded
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            InputStream result = apiInstance.downloadReport(projectId, reportId, taskId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#downloadReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        Integer reportId = 56; // Integer | ID of the Report that is to be generated or downloaded
        Integer taskId = 56; // Integer | ID of the Report Task that is to be downloaded
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            InputStream result = apiInstance.downloadReport(projectId, reportId, taskId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#downloadReport");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
Integer *reportId = 56; // ID of the Report that is to be generated or downloaded
Integer *taskId = 56; // ID of the Report Task that is to be downloaded
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Download Report
[apiInstance downloadReportWith:projectId
    reportId:reportId
    taskId:taskId
    authorization:authorization
              completionHandler: ^(InputStream output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var reportId = 56; // {Integer} ID of the Report that is to be generated or downloaded

var taskId = 56; // {Integer} ID of the Report Task that is to be downloaded

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downloadReport(projectId, reportId, taskId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downloadReportExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var reportId = 56;  // Integer | ID of the Report that is to be generated or downloaded
            var taskId = 56;  // Integer | ID of the Report Task that is to be downloaded
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Download Report
                InputStream result = apiInstance.downloadReport(projectId, reportId, taskId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.downloadReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$reportId = 56; // Integer | ID of the Report that is to be generated or downloaded
$taskId = 56; // Integer | ID of the Report Task that is to be downloaded
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->downloadReport($projectId, $reportId, $taskId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->downloadReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $reportId = 56; # Integer | ID of the Report that is to be generated or downloaded
my $taskId = 56; # Integer | ID of the Report Task that is to be downloaded
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->downloadReport(projectId => $projectId, reportId => $reportId, taskId => $taskId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->downloadReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
reportId = 56 # Integer | ID of the Report that is to be generated or downloaded
taskId = 56 # Integer | ID of the Report Task that is to be downloaded
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Download Report
    api_response = api_instance.download_report(projectId, reportId, taskId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->downloadReport: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
reportId*
Integer (int32)
ID of the Report that is to be generated or downloaded
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
taskId*
Integer (int32)
ID of the Report Task that is to be downloaded
Required

Responses

Status: 200 - OK

Status: 202 - Accepted

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


exportProjectData

Export Project Data

Exports project data for a given projectId. Only Project Admin and Analyst can Export Project Data from a project. Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL. When calling this API from a REST client, you need to redirect output to a zip file as follows curl -X GET "http://HOST:PORT/codeinsight/api/project/exportProjectData?projectId=PROJECT_ID" -H "accept: application/json" -H "Authorization: Bearer JWT_TOKEN" > export.zip


/project/exportProjectData

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//project/exportProjectData?projectId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            InputStream result = apiInstance.exportProjectData(projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#exportProjectData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            InputStream result = apiInstance.exportProjectData(projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#exportProjectData");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Export Project Data
[apiInstance exportProjectDataWith:projectId
    authorization:authorization
              completionHandler: ^(InputStream output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.exportProjectData(projectId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class exportProjectDataExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Export Project Data
                InputStream result = apiInstance.exportProjectData(projectId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.exportProjectData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->exportProjectData($projectId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->exportProjectData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->exportProjectData(projectId => $projectId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->exportProjectData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Export Project Data
    api_response = api_instance.export_project_data(projectId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->exportProjectData: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required

Responses

Status: 200 - OK

Status: 400 - Bad request: No project named x


generateReport

Generate Report

Generates Reports (PROJECT, AUDIT, NOTICES, CUSTOM_REPORT) for a given projectId. For ALL Reports we need to provide the id of the report. All project users including Observer, Reviewer and Analyst can generate reports for private projects.


/projects/{projectId}/reports/{reportId}/generate

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//projects/{projectId}/reports/{reportId}/generate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        Integer reportId = 56; // Integer | ID of the Report that is to be generated
        String authorization = authorization_example; // String | Bearer JWT Token
        ReportsModel body = ; // ReportsModel | The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required.
        try {
            apiInstance.generateReport(projectId, reportId, authorization, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#generateReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        Integer reportId = 56; // Integer | ID of the Report that is to be generated
        String authorization = authorization_example; // String | Bearer JWT Token
        ReportsModel body = ; // ReportsModel | The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required.
        try {
            apiInstance.generateReport(projectId, reportId, authorization, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#generateReport");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
Integer *reportId = 56; // ID of the Report that is to be generated
String *authorization = authorization_example; // Bearer JWT Token (default to )
ReportsModel *body = ; // The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required. (optional)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Generate Report
[apiInstance generateReportWith:projectId
    reportId:reportId
    authorization:authorization
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var reportId = 56; // {Integer} ID of the Report that is to be generated

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'body':  // {ReportsModel} The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.generateReport(projectId, reportId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class generateReportExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var reportId = 56;  // Integer | ID of the Report that is to be generated
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var body = new ReportsModel(); // ReportsModel | The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required. (optional) 

            try
            {
                // Generate Report
                apiInstance.generateReport(projectId, reportId, authorization, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.generateReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$reportId = 56; // Integer | ID of the Report that is to be generated
$authorization = authorization_example; // String | Bearer JWT Token
$body = ; // ReportsModel | The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required.

try {
    $api_instance->generateReport($projectId, $reportId, $authorization, $body);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->generateReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $reportId = 56; # Integer | ID of the Report that is to be generated
my $authorization = authorization_example; # String | Bearer JWT Token
my $body = WWW::SwaggerClient::Object::ReportsModel->new(); # ReportsModel | The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required.

eval { 
    $api_instance->generateReport(projectId => $projectId, reportId => $reportId, authorization => $authorization, body => $body);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->generateReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
reportId = 56 # Integer | ID of the Report that is to be generated
authorization = authorization_example # String | Bearer JWT Token (default to )
body =  # ReportsModel | The success response of the generate is a taskId which should be used during download. If the report type is custom report and enableProjectPicker is true otherProjectId is required. (optional)

try: 
    # Generate Report
    api_instance.generate_report(projectId, reportId, authorization, body=body)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->generateReport: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
reportId*
Integer (int32)
ID of the Report that is to be generated
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getAllChildProjects

get all child projects

Get all child projects. parentProject property will not be shown in the response.


/projects/{projectId}/childProjects

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/childProjects?recursive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean recursive = true; // Boolean | 
        try {
            LinkedProjectModel result = apiInstance.getAllChildProjects(projectId, authorization, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getAllChildProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean recursive = true; // Boolean | 
        try {
            LinkedProjectModel result = apiInstance.getAllChildProjects(projectId, authorization, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getAllChildProjects");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *recursive = true; //  (optional) (default to false)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// get all child projects
[apiInstance getAllChildProjectsWith:projectId
    authorization:authorization
    recursive:recursive
              completionHandler: ^(LinkedProjectModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'recursive': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllChildProjects(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllChildProjectsExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var recursive = true;  // Boolean |  (optional)  (default to false)

            try
            {
                // get all child projects
                LinkedProjectModel result = apiInstance.getAllChildProjects(projectId, authorization, recursive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getAllChildProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token
$recursive = true; // Boolean | 

try {
    $result = $api_instance->getAllChildProjects($projectId, $authorization, $recursive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getAllChildProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token
my $recursive = true; # Boolean | 

eval { 
    my $result = $api_instance->getAllChildProjects(projectId => $projectId, authorization => $authorization, recursive => $recursive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getAllChildProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )
recursive = true # Boolean |  (optional) (default to false)

try: 
    # get all child projects
    api_response = api_instance.get_all_child_projects(projectId, authorization, recursive=recursive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getAllChildProjects: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
recursive
Boolean

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getAllParentProjects

get all parent projects

Get all parent projects. childProject property will not be shown in the response.


/projects/{projectId}/parentProjects

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/parentProjects?recursive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean recursive = true; // Boolean | 
        try {
            LinkedProjectModel result = apiInstance.getAllParentProjects(projectId, authorization, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getAllParentProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean recursive = true; // Boolean | 
        try {
            LinkedProjectModel result = apiInstance.getAllParentProjects(projectId, authorization, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getAllParentProjects");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *recursive = true; //  (optional) (default to false)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// get all parent projects
[apiInstance getAllParentProjectsWith:projectId
    authorization:authorization
    recursive:recursive
              completionHandler: ^(LinkedProjectModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'recursive': true // {Boolean} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllParentProjects(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllParentProjectsExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var recursive = true;  // Boolean |  (optional)  (default to false)

            try
            {
                // get all parent projects
                LinkedProjectModel result = apiInstance.getAllParentProjects(projectId, authorization, recursive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getAllParentProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token
$recursive = true; // Boolean | 

try {
    $result = $api_instance->getAllParentProjects($projectId, $authorization, $recursive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getAllParentProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token
my $recursive = true; # Boolean | 

eval { 
    my $result = $api_instance->getAllParentProjects(projectId => $projectId, authorization => $authorization, recursive => $recursive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getAllParentProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )
recursive = true # Boolean |  (optional) (default to false)

try: 
    # get all parent projects
    api_response = api_instance.get_all_parent_projects(projectId, authorization, recursive=recursive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getAllParentProjects: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
recursive
Boolean

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getAllScannedFiles

Fetch all scanned files for a project


/projects/{projectId}/allscannedfiles

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/allscannedfiles?includeMD5Hash=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean includeMD5Hash = true; // Boolean | if true, display MD5 of the files
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        try {
            apiInstance.getAllScannedFiles(projectId, authorization, includeMD5Hash, offset, limit);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getAllScannedFiles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean includeMD5Hash = true; // Boolean | if true, display MD5 of the files
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        try {
            apiInstance.getAllScannedFiles(projectId, authorization, includeMD5Hash, offset, limit);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getAllScannedFiles");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *includeMD5Hash = true; // if true, display MD5 of the files (optional) (default to false)
Integer *offset = 56; // Index of the page to start with (optional) (default to 1)
Integer *limit = 56; // Number Of Records to fetch (optional) (default to 25)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Fetch all scanned files for a project
[apiInstance getAllScannedFilesWith:projectId
    authorization:authorization
    includeMD5Hash:includeMD5Hash
    offset:offset
    limit:limit
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'includeMD5Hash': true, // {Boolean} if true, display MD5 of the files
  'offset': 56, // {Integer} Index of the page to start with
  'limit': 56 // {Integer} Number Of Records to fetch
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAllScannedFiles(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllScannedFilesExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var includeMD5Hash = true;  // Boolean | if true, display MD5 of the files (optional)  (default to false)
            var offset = 56;  // Integer | Index of the page to start with (optional)  (default to 1)
            var limit = 56;  // Integer | Number Of Records to fetch (optional)  (default to 25)

            try
            {
                // Fetch all scanned files for a project
                apiInstance.getAllScannedFiles(projectId, authorization, includeMD5Hash, offset, limit);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getAllScannedFiles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token
$includeMD5Hash = true; // Boolean | if true, display MD5 of the files
$offset = 56; // Integer | Index of the page to start with
$limit = 56; // Integer | Number Of Records to fetch

try {
    $api_instance->getAllScannedFiles($projectId, $authorization, $includeMD5Hash, $offset, $limit);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getAllScannedFiles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token
my $includeMD5Hash = true; # Boolean | if true, display MD5 of the files
my $offset = 56; # Integer | Index of the page to start with
my $limit = 56; # Integer | Number Of Records to fetch

eval { 
    $api_instance->getAllScannedFiles(projectId => $projectId, authorization => $authorization, includeMD5Hash => $includeMD5Hash, offset => $offset, limit => $limit);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getAllScannedFiles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )
includeMD5Hash = true # Boolean | if true, display MD5 of the files (optional) (default to false)
offset = 56 # Integer | Index of the page to start with (optional) (default to 1)
limit = 56 # Integer | Number Of Records to fetch (optional) (default to 25)

try: 
    # Fetch all scanned files for a project
    api_instance.get_all_scanned_files(projectId, authorization, includeMD5Hash=includeMD5Hash, offset=offset, limit=limit)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getAllScannedFiles: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
includeMD5Hash
Boolean
if true, display MD5 of the files
offset
Integer (int32)
Index of the page to start with
limit
Integer (int32)
Number Of Records to fetch

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getEvidences

Fetch Evidences for a project


/projects/{projectId}/evidences

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/evidences"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getEvidences(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getEvidences");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getEvidences(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getEvidences");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Fetch Evidences for a project
[apiInstance getEvidencesWith:projectId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getEvidences(projectId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEvidencesExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Fetch Evidences for a project
                apiInstance.getEvidences(projectId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getEvidences: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getEvidences($projectId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getEvidences: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getEvidences(projectId => $projectId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getEvidences: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Fetch Evidences for a project
    api_instance.get_evidences(projectId, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getEvidences: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getFileOrFolderId

Get Id of file or folder

Returns the ID of file and/or folder


/projects/{projectId}/files

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/files?filePath=&folderPath="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        String filePath = filePath_example; // String | Path of File
        String folderPath = folderPath_example; // String | Path of Folder
        try {
            Json result = apiInstance.getFileOrFolderId(projectId, authorization, filePath, folderPath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getFileOrFolderId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        String filePath = filePath_example; // String | Path of File
        String folderPath = folderPath_example; // String | Path of Folder
        try {
            Json result = apiInstance.getFileOrFolderId(projectId, authorization, filePath, folderPath);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getFileOrFolderId");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )
String *filePath = filePath_example; // Path of File (optional)
String *folderPath = folderPath_example; // Path of Folder (optional)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Id of file or folder
[apiInstance getFileOrFolderIdWith:projectId
    authorization:authorization
    filePath:filePath
    folderPath:folderPath
              completionHandler: ^(Json output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'filePath': filePath_example, // {String} Path of File
  'folderPath': folderPath_example // {String} Path of Folder
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFileOrFolderId(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFileOrFolderIdExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var filePath = filePath_example;  // String | Path of File (optional) 
            var folderPath = folderPath_example;  // String | Path of Folder (optional) 

            try
            {
                // Get Id of file or folder
                Json result = apiInstance.getFileOrFolderId(projectId, authorization, filePath, folderPath);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getFileOrFolderId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token
$filePath = filePath_example; // String | Path of File
$folderPath = folderPath_example; // String | Path of Folder

try {
    $result = $api_instance->getFileOrFolderId($projectId, $authorization, $filePath, $folderPath);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getFileOrFolderId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token
my $filePath = filePath_example; # String | Path of File
my $folderPath = folderPath_example; # String | Path of Folder

eval { 
    my $result = $api_instance->getFileOrFolderId(projectId => $projectId, authorization => $authorization, filePath => $filePath, folderPath => $folderPath);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getFileOrFolderId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )
filePath = filePath_example # String | Path of File (optional)
folderPath = folderPath_example # String | Path of Folder (optional)

try: 
    # Get Id of file or folder
    api_response = api_instance.get_file_or_folder_id(projectId, authorization, filePath=filePath, folderPath=folderPath)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getFileOrFolderId: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
filePath
String
Path of File
folderPath
String
Path of Folder

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getProjectById

Get Project Information

Get Project Information By Id


/projects/{projectId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            ProjectDetailsDTO result = apiInstance.getProjectById(projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            ProjectDetailsDTO result = apiInstance.getProjectById(projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectById");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Project Information
[apiInstance getProjectByIdWith:projectId
    authorization:authorization
              completionHandler: ^(ProjectDetailsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectById(projectId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectByIdExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Project Information
                ProjectDetailsDTO result = apiInstance.getProjectById(projectId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjectById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->getProjectById($projectId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjectById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->getProjectById(projectId => $projectId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjectById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Project Information
    api_response = api_instance.get_project_by_id(projectId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjectById: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getProjectContact

Get Project Contact

Get project contact for the given projectId.


/projects/{projectId}/contact

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/contact"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            ProjectContact result = apiInstance.getProjectContact(projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            ProjectContact result = apiInstance.getProjectContact(projectId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectContact");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Project Contact
[apiInstance getProjectContactWith:projectId
    authorization:authorization
              completionHandler: ^(ProjectContact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectContact(projectId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectContactExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Project Contact
                ProjectContact result = apiInstance.getProjectContact(projectId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjectContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->getProjectContact($projectId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjectContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->getProjectContact(projectId => $projectId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjectContact: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Project Contact
    api_response = api_instance.get_project_contact(projectId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjectContact: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getProjectId

Get Project Id

Returns projectId for a given projectName.


/project/id

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//project/id?projectName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        String projectName = projectName_example; // String | Name of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'Integer' result = apiInstance.getProjectId(projectName, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        String projectName = projectName_example; // String | Name of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'Integer' result = apiInstance.getProjectId(projectName, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectId");
            e.printStackTrace();
        }
    }
}
String *projectName = projectName_example; // Name of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Project Id
[apiInstance getProjectIdWith:projectName
    authorization:authorization
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectName = projectName_example; // {String} Name of the Project

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectId(projectName, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectIdExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectName = projectName_example;  // String | Name of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Project Id
                'Integer' result = apiInstance.getProjectId(projectName, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjectId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectName = projectName_example; // String | Name of the Project
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->getProjectId($projectName, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjectId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectName = projectName_example; # String | Name of the Project
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->getProjectId(projectName => $projectName, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjectId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectName = projectName_example # String | Name of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Project Id
    api_response = api_instance.get_project_id(projectName, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjectId: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
projectName*
String
Name of the Project
Required

Responses

Status: 200 - OK

Status: 400 - Bad request: The project name entered was not found


getProjectInventory

Get Project Inventory

Returns a list of inventory and inventory details for a given project; includes a flag for a short/long version. All project users including Observer, Reviewer and Analyst can view project inventory of private projects.


/project/inventory/{projectId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//project/inventory/{projectId}?skipVulnerabilities=&published=&vendor=&product=&size=&page=&reviewStatus=&alerts="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean skipVulnerabilities = true; // Boolean | If true , hide vulnerability details in the response
        String published = published_example; // String | If true, then only published inventory items are returned; if false, then only not-published inventory items are returned
        String vendor = vendor_example; // String | CPE Vendor name
        String product = product_example; // String | CPE Product name
        Integer size = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer page = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        String reviewStatus = reviewStatus_example; // String | return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned
        String alerts = alerts_example; // String | return items based the alert status selected. If alert status selected as OPEN then only open alerts returned
        try {
            InventoryGroup result = apiInstance.getProjectInventory(projectId, authorization, skipVulnerabilities, published, vendor, product, size, page, reviewStatus, alerts);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectInventory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean skipVulnerabilities = true; // Boolean | If true , hide vulnerability details in the response
        String published = published_example; // String | If true, then only published inventory items are returned; if false, then only not-published inventory items are returned
        String vendor = vendor_example; // String | CPE Vendor name
        String product = product_example; // String | CPE Product name
        Integer size = 56; // Integer | Page Size. Number Of Records to fetch per page
        Integer page = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
        String reviewStatus = reviewStatus_example; // String | return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned
        String alerts = alerts_example; // String | return items based the alert status selected. If alert status selected as OPEN then only open alerts returned
        try {
            InventoryGroup result = apiInstance.getProjectInventory(projectId, authorization, skipVulnerabilities, published, vendor, product, size, page, reviewStatus, alerts);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectInventory");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *skipVulnerabilities = true; // If true , hide vulnerability details in the response (optional) (default to false)
String *published = published_example; // If true, then only published inventory items are returned; if false, then only not-published inventory items are returned (optional) (default to true)
String *vendor = vendor_example; // CPE Vendor name (optional)
String *product = product_example; // CPE Product name (optional)
Integer *size = 56; // Page Size. Number Of Records to fetch per page (optional) (default to 100)
Integer *page = 56; // Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)
String *reviewStatus = reviewStatus_example; // return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned (optional)
String *alerts = alerts_example; // return items based the alert status selected. If alert status selected as OPEN then only open alerts returned (optional)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Project Inventory
[apiInstance getProjectInventoryWith:projectId
    authorization:authorization
    skipVulnerabilities:skipVulnerabilities
    published:published
    vendor:vendor
    product:product
    size:size
    page:page
    reviewStatus:reviewStatus
    alerts:alerts
              completionHandler: ^(InventoryGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'skipVulnerabilities': true, // {Boolean} If true , hide vulnerability details in the response
  'published': published_example, // {String} If true, then only published inventory items are returned; if false, then only not-published inventory items are returned
  'vendor': vendor_example, // {String} CPE Vendor name
  'product': product_example, // {String} CPE Product name
  'size': 56, // {Integer} Page Size. Number Of Records to fetch per page
  'page': 56, // {Integer} Page Number. Index of the page to start with(starts from 1)
  'reviewStatus': reviewStatus_example, // {String} return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned
  'alerts': alerts_example // {String} return items based the alert status selected. If alert status selected as OPEN then only open alerts returned
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectInventory(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectInventoryExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var skipVulnerabilities = true;  // Boolean | If true , hide vulnerability details in the response (optional)  (default to false)
            var published = published_example;  // String | If true, then only published inventory items are returned; if false, then only not-published inventory items are returned (optional)  (default to true)
            var vendor = vendor_example;  // String | CPE Vendor name (optional) 
            var product = product_example;  // String | CPE Product name (optional) 
            var size = 56;  // Integer | Page Size. Number Of Records to fetch per page (optional)  (default to 100)
            var page = 56;  // Integer | Page Number. Index of the page to start with(starts from 1) (optional)  (default to 1)
            var reviewStatus = reviewStatus_example;  // String | return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned (optional) 
            var alerts = alerts_example;  // String | return items based the alert status selected. If alert status selected as OPEN then only open alerts returned (optional) 

            try
            {
                // Get Project Inventory
                InventoryGroup result = apiInstance.getProjectInventory(projectId, authorization, skipVulnerabilities, published, vendor, product, size, page, reviewStatus, alerts);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjectInventory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token
$skipVulnerabilities = true; // Boolean | If true , hide vulnerability details in the response
$published = published_example; // String | If true, then only published inventory items are returned; if false, then only not-published inventory items are returned
$vendor = vendor_example; // String | CPE Vendor name
$product = product_example; // String | CPE Product name
$size = 56; // Integer | Page Size. Number Of Records to fetch per page
$page = 56; // Integer | Page Number. Index of the page to start with(starts from 1)
$reviewStatus = reviewStatus_example; // String | return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned
$alerts = alerts_example; // String | return items based the alert status selected. If alert status selected as OPEN then only open alerts returned

try {
    $result = $api_instance->getProjectInventory($projectId, $authorization, $skipVulnerabilities, $published, $vendor, $product, $size, $page, $reviewStatus, $alerts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjectInventory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token
my $skipVulnerabilities = true; # Boolean | If true , hide vulnerability details in the response
my $published = published_example; # String | If true, then only published inventory items are returned; if false, then only not-published inventory items are returned
my $vendor = vendor_example; # String | CPE Vendor name
my $product = product_example; # String | CPE Product name
my $size = 56; # Integer | Page Size. Number Of Records to fetch per page
my $page = 56; # Integer | Page Number. Index of the page to start with(starts from 1)
my $reviewStatus = reviewStatus_example; # String | return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned
my $alerts = alerts_example; # String | return items based the alert status selected. If alert status selected as OPEN then only open alerts returned

eval { 
    my $result = $api_instance->getProjectInventory(projectId => $projectId, authorization => $authorization, skipVulnerabilities => $skipVulnerabilities, published => $published, vendor => $vendor, product => $product, size => $size, page => $page, reviewStatus => $reviewStatus, alerts => $alerts);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjectInventory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )
skipVulnerabilities = true # Boolean | If true , hide vulnerability details in the response (optional) (default to false)
published = published_example # String | If true, then only published inventory items are returned; if false, then only not-published inventory items are returned (optional) (default to true)
vendor = vendor_example # String | CPE Vendor name (optional)
product = product_example # String | CPE Product name (optional)
size = 56 # Integer | Page Size. Number Of Records to fetch per page (optional) (default to 100)
page = 56 # Integer | Page Number. Index of the page to start with(starts from 1) (optional) (default to 1)
reviewStatus = reviewStatus_example # String | return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned (optional)
alerts = alerts_example # String | return items based the alert status selected. If alert status selected as OPEN then only open alerts returned (optional)

try: 
    # Get Project Inventory
    api_response = api_instance.get_project_inventory(projectId, authorization, skipVulnerabilities=skipVulnerabilities, published=published, vendor=vendor, product=product, size=size, page=page, reviewStatus=reviewStatus, alerts=alerts)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjectInventory: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
skipVulnerabilities
Boolean
If true , hide vulnerability details in the response
published
String
If true, then only published inventory items are returned; if false, then only not-published inventory items are returned
vendor
String
CPE Vendor name
product
String
CPE Product name
size
Integer (int32)
Page Size. Number Of Records to fetch per page
page
Integer (int32)
Page Number. Index of the page to start with(starts from 1)
reviewStatus
String
return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned
alerts
String
return items based the alert status selected. If alert status selected as OPEN then only open alerts returned

Responses

Status: 200 - OK

Status: 400 - Bad request: The project Id entered was not found


getProjectInventorySummary

Get Inventory Summary of the project

Get Project level inventory summary


/projects/{projectId}/inventorySummary

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/inventorySummary?vulnerabilitySummary=&cvssVersion=&published=&offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean vulnerabilitySummary = true; // Boolean | If false , hide vulnerabilty summary details
        String cvssVersion = cvssVersion_example; // String | CVSS : This field is required only if vulnerabilitySummary is set to true
        String published = published_example; // String | If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        try {
            InventorySummaryModel result = apiInstance.getProjectInventorySummary(projectId, authorization, vulnerabilitySummary, cvssVersion, published, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectInventorySummary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean vulnerabilitySummary = true; // Boolean | If false , hide vulnerabilty summary details
        String cvssVersion = cvssVersion_example; // String | CVSS : This field is required only if vulnerabilitySummary is set to true
        String published = published_example; // String | If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        try {
            InventorySummaryModel result = apiInstance.getProjectInventorySummary(projectId, authorization, vulnerabilitySummary, cvssVersion, published, offset, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectInventorySummary");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *vulnerabilitySummary = true; // If false , hide vulnerabilty summary details (optional) (default to false)
String *cvssVersion = cvssVersion_example; // CVSS : This field is required only if vulnerabilitySummary is set to true (optional)
String *published = published_example; // If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories (optional) (default to PUBLISHED)
Integer *offset = 56; // Index of the page to start with (optional) (default to 1)
Integer *limit = 56; // Number Of Records to fetch (optional) (default to 25)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Inventory Summary of the project
[apiInstance getProjectInventorySummaryWith:projectId
    authorization:authorization
    vulnerabilitySummary:vulnerabilitySummary
    cvssVersion:cvssVersion
    published:published
    offset:offset
    limit:limit
              completionHandler: ^(InventorySummaryModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'vulnerabilitySummary': true, // {Boolean} If false , hide vulnerabilty summary details
  'cvssVersion': cvssVersion_example, // {String} CVSS : This field is required only if vulnerabilitySummary is set to true
  'published': published_example, // {String} If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories
  'offset': 56, // {Integer} Index of the page to start with
  'limit': 56 // {Integer} Number Of Records to fetch
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectInventorySummary(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectInventorySummaryExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var vulnerabilitySummary = true;  // Boolean | If false , hide vulnerabilty summary details (optional)  (default to false)
            var cvssVersion = cvssVersion_example;  // String | CVSS : This field is required only if vulnerabilitySummary is set to true (optional) 
            var published = published_example;  // String | If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories (optional)  (default to PUBLISHED)
            var offset = 56;  // Integer | Index of the page to start with (optional)  (default to 1)
            var limit = 56;  // Integer | Number Of Records to fetch (optional)  (default to 25)

            try
            {
                // Get Inventory Summary of the project
                InventorySummaryModel result = apiInstance.getProjectInventorySummary(projectId, authorization, vulnerabilitySummary, cvssVersion, published, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjectInventorySummary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token
$vulnerabilitySummary = true; // Boolean | If false , hide vulnerabilty summary details
$cvssVersion = cvssVersion_example; // String | CVSS : This field is required only if vulnerabilitySummary is set to true
$published = published_example; // String | If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories
$offset = 56; // Integer | Index of the page to start with
$limit = 56; // Integer | Number Of Records to fetch

try {
    $result = $api_instance->getProjectInventorySummary($projectId, $authorization, $vulnerabilitySummary, $cvssVersion, $published, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjectInventorySummary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token
my $vulnerabilitySummary = true; # Boolean | If false , hide vulnerabilty summary details
my $cvssVersion = cvssVersion_example; # String | CVSS : This field is required only if vulnerabilitySummary is set to true
my $published = published_example; # String | If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories
my $offset = 56; # Integer | Index of the page to start with
my $limit = 56; # Integer | Number Of Records to fetch

eval { 
    my $result = $api_instance->getProjectInventorySummary(projectId => $projectId, authorization => $authorization, vulnerabilitySummary => $vulnerabilitySummary, cvssVersion => $cvssVersion, published => $published, offset => $offset, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjectInventorySummary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )
vulnerabilitySummary = true # Boolean | If false , hide vulnerabilty summary details (optional) (default to false)
cvssVersion = cvssVersion_example # String | CVSS : This field is required only if vulnerabilitySummary is set to true (optional)
published = published_example # String | If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories (optional) (default to PUBLISHED)
offset = 56 # Integer | Index of the page to start with (optional) (default to 1)
limit = 56 # Integer | Number Of Records to fetch (optional) (default to 25)

try: 
    # Get Inventory Summary of the project
    api_response = api_instance.get_project_inventory_summary(projectId, authorization, vulnerabilitySummary=vulnerabilitySummary, cvssVersion=cvssVersion, published=published, offset=offset, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjectInventorySummary: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
vulnerabilitySummary
Boolean
If false , hide vulnerabilty summary details
cvssVersion
String
CVSS : This field is required only if vulnerabilitySummary is set to true
published
String
If published, then only published inventory items are returned; if unpublished, then only not-published inventory items are returned; if all, then return all inventories
offset
Integer (int32)
Index of the page to start with
limit
Integer (int32)
Number Of Records to fetch

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getProjectScanStatus

Get Scan Status

Returns a scan status for a given taskId which is obtained from /projectScan/{projectId}


/project/scanStatus/{taskId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//project/scanStatus/{taskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer taskId = 56; // Integer | ID of the project scan task
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.getProjectScanStatus(taskId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectScanStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer taskId = 56; // Integer | ID of the project scan task
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.getProjectScanStatus(taskId, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectScanStatus");
            e.printStackTrace();
        }
    }
}
Integer *taskId = 56; // ID of the project scan task
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Scan Status
[apiInstance getProjectScanStatusWith:taskId
    authorization:authorization
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var taskId = 56; // {Integer} ID of the project scan task

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectScanStatus(taskId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectScanStatusExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var taskId = 56;  // Integer | ID of the project scan task
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Scan Status
                'String' result = apiInstance.getProjectScanStatus(taskId, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjectScanStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$taskId = 56; // Integer | ID of the project scan task
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->getProjectScanStatus($taskId, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjectScanStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $taskId = 56; # Integer | ID of the project scan task
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->getProjectScanStatus(taskId => $taskId, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjectScanStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
taskId = 56 # Integer | ID of the project scan task
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Scan Status
    api_response = api_instance.get_project_scan_status(taskId, authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjectScanStatus: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Integer (int32)
ID of the project scan task
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - SCHEDULED | ACTIVE | TERMINATED | FAILED | COMPLETED

Status: 400 - Bad request: The task Id entered was not found


getProjectUserRole

Users

Get Project Users with respect to Role


/projects/{projectId}/users

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/users?roleId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String roleId = roleId_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getProjectUserRole(projectId, roleId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectUserRole");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String roleId = roleId_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getProjectUserRole(projectId, roleId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjectUserRole");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *roleId = roleId_example; //  (default to ANALYST)
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Users
[apiInstance getProjectUserRoleWith:projectId
    roleId:roleId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var roleId = roleId_example; // {String} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getProjectUserRole(projectId, roleId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectUserRoleExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var roleId = roleId_example;  // String |  (default to ANALYST)
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Users
                apiInstance.getProjectUserRole(projectId, roleId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjectUserRole: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$roleId = roleId_example; // String | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getProjectUserRole($projectId, $roleId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjectUserRole: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $roleId = roleId_example; # String | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getProjectUserRole(projectId => $projectId, roleId => $roleId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjectUserRole: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
roleId = roleId_example # String |  (default to ANALYST)
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Users
    api_instance.get_project_user_role(projectId, roleId, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjectUserRole: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
roleId*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 404 - Not Found

Status: 500 - Internal Server Error


getProjects

Get Projects

Get All The Projects


/projects

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getProjects(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getProjects(authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getProjects");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Get Projects
[apiInstance getProjectsWith:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getProjects(authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectsExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Projects
                apiInstance.getProjects(authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getProjects($authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getProjects(authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Projects
    api_instance.get_projects(authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getProjects: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getScanNodes

Fetch all scan nodes (alias) of a project

Returns all the alias node information of a project


/projects/{projectId}/scanNodes

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//projects/{projectId}/scanNodes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getScanNodes(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getScanNodes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getScanNodes(projectId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#getScanNodes");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Fetch all scan nodes (alias) of a project
[apiInstance getScanNodesWith:projectId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getScanNodes(projectId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScanNodesExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Fetch all scan nodes (alias) of a project
                apiInstance.getScanNodes(projectId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.getScanNodes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getScanNodes($projectId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->getScanNodes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getScanNodes(projectId => $projectId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->getScanNodes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Fetch all scan nodes (alias) of a project
    api_instance.get_scan_nodes(projectId, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->getScanNodes: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


importProjectData1

Import Project Data

Imports project data for a given projectId. Only Project Owner and Analyst can Import Project Data into a private project. Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL When calling this API from a REST client, you need to run either of the curl commands. Save the required attributes in a json or a text file for project import and provide that file in the command. If you are using text file, don't give .txt extension. curl -H "Authorization:Bearer %jwt%" -F importFile=@"fileToImport.zip" -F projectImportModel=@"JsonFile.json Or textFile;type=application/json" http://localhost:8888/codeinsight/api/projects/%projectId%/import Or else, instead of providing file, you can directly define the attributes for projectImportModel inside curly braces. Provide 'FileMatchingCriteria' either of the below values: COMPLETE_FILEPATH|PARTIAL_FILEPATH|FILENAME|MD5|MD5_AND_FILENAME|MD5_AND_COMPLETE_FILEPATH|MD5_AND_PARTIAL_FILEPATH


/projects/{projectId}/import

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//projects/{projectId}/import"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | 
        String authorization = authorization_example; // String | Bearer JWT Token
        InputStream file to import = ; // InputStream | 
        try {
            'String' result = apiInstance.importProjectData1(projectId, authorization, file to import);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#importProjectData1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | 
        String authorization = authorization_example; // String | Bearer JWT Token
        InputStream file to import = ; // InputStream | 
        try {
            'String' result = apiInstance.importProjectData1(projectId, authorization, file to import);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#importProjectData1");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // 
String *authorization = authorization_example; // Bearer JWT Token (default to )
InputStream *file to import = ; //  (optional)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Import Project Data
[apiInstance importProjectData1With:projectId
    authorization:authorization
    file to import:file to import
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} 

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'file to import':  // {InputStream} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importProjectData1(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class importProjectData1Example
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var file to import = new InputStream(); // InputStream |  (optional) 

            try
            {
                // Import Project Data
                'String' result = apiInstance.importProjectData1(projectId, authorization, file to import);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.importProjectData1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | 
$authorization = authorization_example; // String | Bearer JWT Token
$file to import = ; // InputStream | 

try {
    $result = $api_instance->importProjectData1($projectId, $authorization, $file to import);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->importProjectData1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | 
my $authorization = authorization_example; # String | Bearer JWT Token
my $file to import = WWW::SwaggerClient::Object::InputStream->new(); # InputStream | 

eval { 
    my $result = $api_instance->importProjectData1(projectId => $projectId, authorization => $authorization, file to import => $file to import);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->importProjectData1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | 
authorization = authorization_example # String | Bearer JWT Token (default to )
file to import =  # InputStream |  (optional)

try: 
    # Import Project Data
    api_response = api_instance.import_project_data1(projectId, authorization, file to import=file to import)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->importProjectData1: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
file to import

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


removeChildProjects

Remove child Projects from parent project

Remove child project from parent project


/projects/{projectId}/children

Usage and SDK Samples

curl -X DELETE "http://localhost/codeinsight/api//projects/{projectId}/children?childProjectIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | Id of Parent Project
        array[Integer] childProjectIds = ; // array[Integer] | Id of Child Projects
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.removeChildProjects(projectId, childProjectIds, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#removeChildProjects");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | Id of Parent Project
        array[Integer] childProjectIds = ; // array[Integer] | Id of Child Projects
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.removeChildProjects(projectId, childProjectIds, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#removeChildProjects");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // Id of Parent Project
array[Integer] *childProjectIds = ; // Id of Child Projects
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Remove child Projects from parent project
[apiInstance removeChildProjectsWith:projectId
    childProjectIds:childProjectIds
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} Id of Parent Project

var childProjectIds = ; // {array[Integer]} Id of Child Projects

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeChildProjects(projectId, childProjectIds, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class removeChildProjectsExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | Id of Parent Project
            var childProjectIds = new array[Integer](); // array[Integer] | Id of Child Projects
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Remove child Projects from parent project
                apiInstance.removeChildProjects(projectId, childProjectIds, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.removeChildProjects: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | Id of Parent Project
$childProjectIds = ; // array[Integer] | Id of Child Projects
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->removeChildProjects($projectId, $childProjectIds, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->removeChildProjects: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | Id of Parent Project
my $childProjectIds = []; # array[Integer] | Id of Child Projects
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->removeChildProjects(projectId => $projectId, childProjectIds => $childProjectIds, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->removeChildProjects: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | Id of Parent Project
childProjectIds =  # array[Integer] | Id of Child Projects
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Remove child Projects from parent project
    api_instance.remove_child_projects(projectId, childProjectIds, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->removeChildProjects: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
Id of Parent Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
childProjectIds*
array[Integer] (int32)
Id of Child Projects
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not found

Status: 500 - Internal Server Error


unassignProjectRoles

Unassign Project Role

Remove User(s) from a specific Project Role


/projects/{projectId}/users

Usage and SDK Samples

curl -X DELETE "http://localhost/codeinsight/api//projects/{projectId}/users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        UsersRole body = ; // UsersRole | Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.unassignProjectRoles(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#unassignProjectRoles");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        UsersRole body = ; // UsersRole | Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.unassignProjectRoles(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#unassignProjectRoles");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
UsersRole *body = ; // Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Unassign Project Role
[apiInstance unassignProjectRolesWith:projectId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var body = ; // {UsersRole} Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.unassignProjectRoles(projectId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unassignProjectRolesExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var body = new UsersRole(); // UsersRole | Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Unassign Project Role
                apiInstance.unassignProjectRoles(projectId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.unassignProjectRoles: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$body = ; // UsersRole | Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->unassignProjectRoles($projectId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->unassignProjectRoles: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $body = WWW::SwaggerClient::Object::UsersRole->new(); # UsersRole | Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->unassignProjectRoles(projectId => $projectId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->unassignProjectRoles: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
body =  # UsersRole | Remove User(s) from a specific Project Role. Accepted RoleId: PROJECT_ADMIN, ANALYST, REVIEWER, OBSERVER
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Unassign Project Role
    api_instance.unassign_project_roles(projectId, body, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->unassignProjectRoles: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


updateProject

Update Project

Updates a project for the given projectId. Here "owner" field refers to the "contact" of the project


/projects/{projectId}

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//projects/{projectId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        ExtendedProjectModel body = ; // ExtendedProjectModel | Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateProject(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#updateProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        ExtendedProjectModel body = ; // ExtendedProjectModel | Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateProject(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#updateProject");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
ExtendedProjectModel *body = ; // Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Update Project
[apiInstance updateProjectWith:projectId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var body = ; // {ExtendedProjectModel} Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProject(projectId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var body = new ExtendedProjectModel(); // ExtendedProjectModel | Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Update Project
                apiInstance.updateProject(projectId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.updateProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$body = ; // ExtendedProjectModel | Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateProject($projectId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->updateProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $body = WWW::SwaggerClient::Object::ExtendedProjectModel->new(); # ExtendedProjectModel | Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateProject(projectId => $projectId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->updateProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
body =  # ExtendedProjectModel | Updates a project, autoPublish is required when markAssociatedFilesAsReviewed and doNotPublishInventoryUnknownLicense is part of a request.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Update Project
    api_instance.update_project(projectId, body, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->updateProject: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


updateProjectContact

Update Project Contact

Updates project contact for the given projectId.


/projects/{projectId}/contact

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//projects/{projectId}/contact"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        ProjectContact body = ; // ProjectContact | Updates a project contact
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateProjectContact(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#updateProjectContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        ProjectContact body = ; // ProjectContact | Updates a project contact
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateProjectContact(projectId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#updateProjectContact");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
ProjectContact *body = ; // Updates a project contact
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Update Project Contact
[apiInstance updateProjectContactWith:projectId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var body = ; // {ProjectContact} Updates a project contact

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProjectContact(projectId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectContactExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var body = new ProjectContact(); // ProjectContact | Updates a project contact
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Update Project Contact
                apiInstance.updateProjectContact(projectId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.updateProjectContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$body = ; // ProjectContact | Updates a project contact
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateProjectContact($projectId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->updateProjectContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $body = WWW::SwaggerClient::Object::ProjectContact->new(); # ProjectContact | Updates a project contact
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateProjectContact(projectId => $projectId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->updateProjectContact: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
body =  # ProjectContact | Updates a project contact
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Update Project Contact
    api_instance.update_project_contact(projectId, body, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->updateProjectContact: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


updateProjectStatus

project status

update project status. After creating the project, the default status is 'Not Started' and the status will be automatically updated to 'Analysis In Progress' after scanning.


/projects/{projectId}/status

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//projects/{projectId}/status?status="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String status = status_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateProjectStatus(projectId, status, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#updateProjectStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        String status = status_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateProjectStatus(projectId, status, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#updateProjectStatus");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
String *status = status_example; //  (default to Not Started)
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// project status
[apiInstance updateProjectStatusWith:projectId
    status:status
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var status = status_example; // {String} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProjectStatus(projectId, status, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProjectStatusExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var status = status_example;  // String |  (default to Not Started)
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // project status
                apiInstance.updateProjectStatus(projectId, status, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.updateProjectStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$status = status_example; // String | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateProjectStatus($projectId, $status, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->updateProjectStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $status = status_example; # String | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateProjectStatus(projectId => $projectId, status => $status, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->updateProjectStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
status = status_example # String |  (default to Not Started)
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # project status
    api_instance.update_project_status(projectId, status, authorization)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->updateProjectStatus: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
status*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


uploadProject

Upload Project Files.

Uploads and extracts a codebase zip file for a project. (* Maximum supported file size is 10GB.). Upload only files with extensions zip,tar,tar.gz and 7z. Do not upload any .gz files directly without archiving it in a tar file. The upload result may come wrong if any compressed files uploaded directly without archiving it. Only Project Admin and Analyst can upload project codebase to a project. Try it out is not available for this API. This API can be tested using conventional REST API clients such as postman or cURL. When calling this API from a REST client, you need to run curl as follows curl -X POST "http://HOST:PORT/codeinsight/api/project/uploadProjectCodebase?projectId=PROJECT_ID&deleteExistingFileOnServer=true&expansionLevel=1" -H "accept: application/json" -H "Authorization: Bearer JWT_TOKEN" -H "content-type: application/octet-stream" --data-binary "@path/filename.zip"


/project/uploadProjectCodebase

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//project/uploadProjectCodebase?projectId=&deleteExistingFileOnServer=&expansionLevel=&deleteArchiveAfterExpand=&archiveDirSuffix="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        InputStream upload Codebase = ; // InputStream | Zipped codebase to scan
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean deleteExistingFileOnServer = true; // Boolean | Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted.
        Integer expansionLevel = 56; // Integer | Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default.
        Boolean deleteArchiveAfterExpand = true; // Boolean | Delete inner archives after expansion
        String archiveDirSuffix = archiveDirSuffix_example; // String | Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0
        try {
            'String' result = apiInstance.uploadProject(projectId, upload Codebase, authorization, deleteExistingFileOnServer, expansionLevel, deleteArchiveAfterExpand, archiveDirSuffix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#uploadProject");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        Integer projectId = 56; // Integer | ID of the Project
        InputStream upload Codebase = ; // InputStream | Zipped codebase to scan
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean deleteExistingFileOnServer = true; // Boolean | Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted.
        Integer expansionLevel = 56; // Integer | Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default.
        Boolean deleteArchiveAfterExpand = true; // Boolean | Delete inner archives after expansion
        String archiveDirSuffix = archiveDirSuffix_example; // String | Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0
        try {
            'String' result = apiInstance.uploadProject(projectId, upload Codebase, authorization, deleteExistingFileOnServer, expansionLevel, deleteArchiveAfterExpand, archiveDirSuffix);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#uploadProject");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the Project
InputStream *upload Codebase = ; // Zipped codebase to scan
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *deleteExistingFileOnServer = true; // Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted. (optional) (default to false)
Integer *expansionLevel = 56; // Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default. (optional)
Boolean *deleteArchiveAfterExpand = true; // Delete inner archives after expansion (optional) (default to false)
String *archiveDirSuffix = archiveDirSuffix_example; // Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0 (optional)

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Upload Project Files.
[apiInstance uploadProjectWith:projectId
    upload Codebase:upload Codebase
    authorization:authorization
    deleteExistingFileOnServer:deleteExistingFileOnServer
    expansionLevel:expansionLevel
    deleteArchiveAfterExpand:deleteArchiveAfterExpand
    archiveDirSuffix:archiveDirSuffix
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var projectId = 56; // {Integer} ID of the Project

var upload Codebase = ; // {InputStream} Zipped codebase to scan

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'deleteExistingFileOnServer': true, // {Boolean} Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted.
  'expansionLevel': 56, // {Integer} Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default.
  'deleteArchiveAfterExpand': true, // {Boolean} Delete inner archives after expansion
  'archiveDirSuffix': archiveDirSuffix_example // {String} Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadProject(projectId, upload Codebase, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadProjectExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var projectId = 56;  // Integer | ID of the Project
            var upload Codebase = new InputStream(); // InputStream | Zipped codebase to scan
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var deleteExistingFileOnServer = true;  // Boolean | Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted. (optional)  (default to false)
            var expansionLevel = 56;  // Integer | Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default. (optional) 
            var deleteArchiveAfterExpand = true;  // Boolean | Delete inner archives after expansion (optional)  (default to false)
            var archiveDirSuffix = archiveDirSuffix_example;  // String | Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0 (optional) 

            try
            {
                // Upload Project Files.
                'String' result = apiInstance.uploadProject(projectId, upload Codebase, authorization, deleteExistingFileOnServer, expansionLevel, deleteArchiveAfterExpand, archiveDirSuffix);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.uploadProject: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$projectId = 56; // Integer | ID of the Project
$upload Codebase = ; // InputStream | Zipped codebase to scan
$authorization = authorization_example; // String | Bearer JWT Token
$deleteExistingFileOnServer = true; // Boolean | Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted.
$expansionLevel = 56; // Integer | Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default.
$deleteArchiveAfterExpand = true; // Boolean | Delete inner archives after expansion
$archiveDirSuffix = archiveDirSuffix_example; // String | Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0

try {
    $result = $api_instance->uploadProject($projectId, $upload Codebase, $authorization, $deleteExistingFileOnServer, $expansionLevel, $deleteArchiveAfterExpand, $archiveDirSuffix);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->uploadProject: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $projectId = 56; # Integer | ID of the Project
my $upload Codebase = WWW::SwaggerClient::Object::InputStream->new(); # InputStream | Zipped codebase to scan
my $authorization = authorization_example; # String | Bearer JWT Token
my $deleteExistingFileOnServer = true; # Boolean | Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted.
my $expansionLevel = 56; # Integer | Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default.
my $deleteArchiveAfterExpand = true; # Boolean | Delete inner archives after expansion
my $archiveDirSuffix = archiveDirSuffix_example; # String | Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0

eval { 
    my $result = $api_instance->uploadProject(projectId => $projectId, upload Codebase => $upload Codebase, authorization => $authorization, deleteExistingFileOnServer => $deleteExistingFileOnServer, expansionLevel => $expansionLevel, deleteArchiveAfterExpand => $deleteArchiveAfterExpand, archiveDirSuffix => $archiveDirSuffix);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->uploadProject: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
projectId = 56 # Integer | ID of the Project
upload Codebase =  # InputStream | Zipped codebase to scan
authorization = authorization_example # String | Bearer JWT Token (default to )
deleteExistingFileOnServer = true # Boolean | Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted. (optional) (default to false)
expansionLevel = 56 # Integer | Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default. (optional)
deleteArchiveAfterExpand = true # Boolean | Delete inner archives after expansion (optional) (default to false)
archiveDirSuffix = archiveDirSuffix_example # String | Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters  \ / : * ? " < > | \0 (optional)

try: 
    # Upload Project Files.
    api_response = api_instance.upload_project(projectId, upload Codebase, authorization, deleteExistingFileOnServer=deleteExistingFileOnServer, expansionLevel=expansionLevel, deleteArchiveAfterExpand=deleteArchiveAfterExpand, archiveDirSuffix=archiveDirSuffix)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->uploadProject: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
upload Codebase *
Query parameters
Name Description
projectId*
Integer (int32)
ID of the Project
Required
deleteExistingFileOnServer
Boolean
Delete existing files on server. By deleting exiting files on the server, all existing project codebase files will be permanently removed from the scan server. If you rescan the project without replacing these files via a new upload, the scan results for the removed files will be permanently deleted.
expansionLevel
Integer (int32)
Codebase expansion level for the project. 1: None | 2: First level | 3: Recursive level . If the expansionLevel parameter is not provided, the codebase will get extracted as 'None' by default.
deleteArchiveAfterExpand
Boolean
Delete inner archives after expansion
archiveDirSuffix
String
Suffix to be added to the expanded folder. Value cannot be more than 20 characters and cannot contain the following special characters \ / : * ? " < > | \0

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 500 - Internal Server Error


uploadReport

Upload Report.

Uploads and extracts a report zip file for a project.curl -H "Authorization: Bearer %jwt%" --form projectId=%projectId% --form reportId=%reportId% --form file=@"pdf_reports.zip" http://localhost:8888/codeinsight/api/projects/uploadReport


/projects/uploadReport

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//projects/uploadReport"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProjectAPIApi;

import java.io.File;
import java.util.*;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.uploadReport(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#uploadReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProjectAPIApi;

public class ProjectAPIApiExample {

    public static void main(String[] args) {
        ProjectAPIApi apiInstance = new ProjectAPIApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            'String' result = apiInstance.uploadReport(authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectAPIApi#uploadReport");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer JWT Token (default to )

ProjectAPIApi *apiInstance = [[ProjectAPIApi alloc] init];

// Upload Report.
[apiInstance uploadReportWith:authorization
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ProjectAPIApi()

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadReport(authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadReportExample
    {
        public void main()
        {
            
            var apiInstance = new ProjectAPIApi();
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Upload Report.
                'String' result = apiInstance.uploadReport(authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProjectAPIApi.uploadReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ProjectAPIApi();
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $result = $api_instance->uploadReport($authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectAPIApi->uploadReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProjectAPIApi;

my $api_instance = WWW::SwaggerClient::ProjectAPIApi->new();
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    my $result = $api_instance->uploadReport(authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectAPIApi->uploadReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProjectAPIApi()
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Upload Report.
    api_response = api_instance.upload_report(authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectAPIApi->uploadReport: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


Reports

createReport

Create Report

Add new report. All the report options, if given will have datatype as String/text.


/reports

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        ReportModel body = ; // ReportModel | Add new report.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createReport(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#createReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        ReportModel body = ; // ReportModel | Add new report.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createReport(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#createReport");
            e.printStackTrace();
        }
    }
}
ReportModel *body = ; // Add new report.
String *authorization = authorization_example; // Bearer JWT Token (default to )

ReportsApi *apiInstance = [[ReportsApi alloc] init];

// Create Report
[apiInstance createReportWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ReportsApi()

var body = ; // {ReportModel} Add new report.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createReport(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createReportExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var body = new ReportModel(); // ReportModel | Add new report.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create Report
                apiInstance.createReport(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.createReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$body = ; // ReportModel | Add new report.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createReport($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->createReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $body = WWW::SwaggerClient::Object::ReportModel->new(); # ReportModel | Add new report.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createReport(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ReportsApi->createReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
body =  # ReportModel | Add new report.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create Report
    api_instance.create_report(body, authorization)
except ApiException as e:
    print("Exception when calling ReportsApi->createReport: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteReport

Delete Report

Delete the report


/reports/{reportName}/

Usage and SDK Samples

curl -X DELETE "http://localhost/codeinsight/api//reports/{reportName}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        String reportName = reportName_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteReport(reportName, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#deleteReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String reportName = reportName_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteReport(reportName, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#deleteReport");
            e.printStackTrace();
        }
    }
}
String *reportName = reportName_example; // 
String *authorization = authorization_example; // Bearer JWT Token (default to )

ReportsApi *apiInstance = [[ReportsApi alloc] init];

// Delete Report
[apiInstance deleteReportWith:reportName
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ReportsApi()

var reportName = reportName_example; // {String} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteReport(reportName, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteReportExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var reportName = reportName_example;  // String | 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Delete Report
                apiInstance.deleteReport(reportName, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.deleteReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$reportName = reportName_example; // String | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->deleteReport($reportName, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->deleteReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $reportName = reportName_example; # String | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->deleteReport(reportName => $reportName, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ReportsApi->deleteReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
reportName = reportName_example # String | 
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Delete Report
    api_instance.delete_report(reportName, authorization)
except ApiException as e:
    print("Exception when calling ReportsApi->deleteReport: %s\n" % e)

Parameters

Path parameters
Name Description
reportName*
String
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getReport

Get Report By Id

Get existing report by reportId


/reports/{reportId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//reports/{reportId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        Integer reportId = 56; // Integer | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getReport(reportId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer reportId = 56; // Integer | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getReport(reportId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getReport");
            e.printStackTrace();
        }
    }
}
Integer *reportId = 56; // 
String *authorization = authorization_example; // Bearer JWT Token (default to )

ReportsApi *apiInstance = [[ReportsApi alloc] init];

// Get Report By Id
[apiInstance getReportWith:reportId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ReportsApi()

var reportId = 56; // {Integer} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getReport(reportId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReportExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var reportId = 56;  // Integer | 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Report By Id
                apiInstance.getReport(reportId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$reportId = 56; // Integer | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getReport($reportId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->getReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $reportId = 56; # Integer | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getReport(reportId => $reportId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ReportsApi->getReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
reportId = 56 # Integer | 
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Report By Id
    api_instance.get_report(reportId, authorization)
except ApiException as e:
    print("Exception when calling ReportsApi->getReport: %s\n" % e)

Parameters

Path parameters
Name Description
reportId*
Integer (int32)
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


searchReports

Get Reports

Get existing reports


/reports

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//reports?reportId=&offset=&limit=&name=&path=&enabled=&default=&order="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer reportId = 56; // Integer | ID of the Report to be used in search
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        String name = name_example; // String | Name of the Report to be used in search
        String path = path_example; // String | Path of the Script to be used in search
        Boolean enabled = true; // Boolean | Enabled status of the Report to be used in search
        Boolean default = true; // Boolean | Default status of the Report to be used in search
        Integer order = 56; // Integer | Order of the Report to be used in search
        try {
            apiInstance.searchReports(authorization, reportId, offset, limit, name, path, enabled, default, order);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#searchReports");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer reportId = 56; // Integer | ID of the Report to be used in search
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        String name = name_example; // String | Name of the Report to be used in search
        String path = path_example; // String | Path of the Script to be used in search
        Boolean enabled = true; // Boolean | Enabled status of the Report to be used in search
        Boolean default = true; // Boolean | Default status of the Report to be used in search
        Integer order = 56; // Integer | Order of the Report to be used in search
        try {
            apiInstance.searchReports(authorization, reportId, offset, limit, name, path, enabled, default, order);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#searchReports");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *reportId = 56; // ID of the Report to be used in search (optional)
Integer *offset = 56; // Index of the page to start with (optional) (default to 1)
Integer *limit = 56; // Number Of Records to fetch (optional) (default to 25)
String *name = name_example; // Name of the Report to be used in search (optional)
String *path = path_example; // Path of the Script to be used in search (optional)
Boolean *enabled = true; // Enabled status of the Report to be used in search (optional)
Boolean *default = true; // Default status of the Report to be used in search (optional)
Integer *order = 56; // Order of the Report to be used in search (optional)

ReportsApi *apiInstance = [[ReportsApi alloc] init];

// Get Reports
[apiInstance searchReportsWith:authorization
    reportId:reportId
    offset:offset
    limit:limit
    name:name
    path:path
    enabled:enabled
    default:default
    order:order
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ReportsApi()

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'reportId': 56, // {Integer} ID of the Report to be used in search
  'offset': 56, // {Integer} Index of the page to start with
  'limit': 56, // {Integer} Number Of Records to fetch
  'name': name_example, // {String} Name of the Report to be used in search
  'path': path_example, // {String} Path of the Script to be used in search
  'enabled': true, // {Boolean} Enabled status of the Report to be used in search
  'default': true, // {Boolean} Default status of the Report to be used in search
  'order': 56 // {Integer} Order of the Report to be used in search
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchReports(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchReportsExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var reportId = 56;  // Integer | ID of the Report to be used in search (optional) 
            var offset = 56;  // Integer | Index of the page to start with (optional)  (default to 1)
            var limit = 56;  // Integer | Number Of Records to fetch (optional)  (default to 25)
            var name = name_example;  // String | Name of the Report to be used in search (optional) 
            var path = path_example;  // String | Path of the Script to be used in search (optional) 
            var enabled = true;  // Boolean | Enabled status of the Report to be used in search (optional) 
            var default = true;  // Boolean | Default status of the Report to be used in search (optional) 
            var order = 56;  // Integer | Order of the Report to be used in search (optional) 

            try
            {
                // Get Reports
                apiInstance.searchReports(authorization, reportId, offset, limit, name, path, enabled, default, order);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.searchReports: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$authorization = authorization_example; // String | Bearer JWT Token
$reportId = 56; // Integer | ID of the Report to be used in search
$offset = 56; // Integer | Index of the page to start with
$limit = 56; // Integer | Number Of Records to fetch
$name = name_example; // String | Name of the Report to be used in search
$path = path_example; // String | Path of the Script to be used in search
$enabled = true; // Boolean | Enabled status of the Report to be used in search
$default = true; // Boolean | Default status of the Report to be used in search
$order = 56; // Integer | Order of the Report to be used in search

try {
    $api_instance->searchReports($authorization, $reportId, $offset, $limit, $name, $path, $enabled, $default, $order);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->searchReports: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $authorization = authorization_example; # String | Bearer JWT Token
my $reportId = 56; # Integer | ID of the Report to be used in search
my $offset = 56; # Integer | Index of the page to start with
my $limit = 56; # Integer | Number Of Records to fetch
my $name = name_example; # String | Name of the Report to be used in search
my $path = path_example; # String | Path of the Script to be used in search
my $enabled = true; # Boolean | Enabled status of the Report to be used in search
my $default = true; # Boolean | Default status of the Report to be used in search
my $order = 56; # Integer | Order of the Report to be used in search

eval { 
    $api_instance->searchReports(authorization => $authorization, reportId => $reportId, offset => $offset, limit => $limit, name => $name, path => $path, enabled => $enabled, default => $default, order => $order);
};
if ($@) {
    warn "Exception when calling ReportsApi->searchReports: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
authorization = authorization_example # String | Bearer JWT Token (default to )
reportId = 56 # Integer | ID of the Report to be used in search (optional)
offset = 56 # Integer | Index of the page to start with (optional) (default to 1)
limit = 56 # Integer | Number Of Records to fetch (optional) (default to 25)
name = name_example # String | Name of the Report to be used in search (optional)
path = path_example # String | Path of the Script to be used in search (optional)
enabled = true # Boolean | Enabled status of the Report to be used in search (optional)
default = true # Boolean | Default status of the Report to be used in search (optional)
order = 56 # Integer | Order of the Report to be used in search (optional)

try: 
    # Get Reports
    api_instance.search_reports(authorization, reportId=reportId, offset=offset, limit=limit, name=name, path=path, enabled=enabled, default=default, order=order)
except ApiException as e:
    print("Exception when calling ReportsApi->searchReports: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
reportId
Integer (int32)
ID of the Report to be used in search
offset
Integer (int32)
Index of the page to start with
limit
Integer (int32)
Number Of Records to fetch
name
String
Name of the Report to be used in search
path
String
Path of the Script to be used in search
enabled
Boolean
Enabled status of the Report to be used in search
default
Boolean
Default status of the Report to be used in search
order
Integer (int32)
Order of the Report to be used in search

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


updateReport

Update Report

Update existing report


/reports

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

import java.io.File;
import java.util.*;

public class ReportsApiExample {

    public static void main(String[] args) {
        
        ReportsApi apiInstance = new ReportsApi();
        ExtendedReportModel body = ; // ExtendedReportModel | Update existing report.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateReport(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#updateReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        ExtendedReportModel body = ; // ExtendedReportModel | Update existing report.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateReport(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#updateReport");
            e.printStackTrace();
        }
    }
}
ExtendedReportModel *body = ; // Update existing report.
String *authorization = authorization_example; // Bearer JWT Token (default to )

ReportsApi *apiInstance = [[ReportsApi alloc] init];

// Update Report
[apiInstance updateReportWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ReportsApi()

var body = ; // {ExtendedReportModel} Update existing report.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateReport(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateReportExample
    {
        public void main()
        {
            
            var apiInstance = new ReportsApi();
            var body = new ExtendedReportModel(); // ExtendedReportModel | Update existing report.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Update Report
                apiInstance.updateReport(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.updateReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ReportsApi();
$body = ; // ExtendedReportModel | Update existing report.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateReport($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->updateReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportsApi;

my $api_instance = WWW::SwaggerClient::ReportsApi->new();
my $body = WWW::SwaggerClient::Object::ExtendedReportModel->new(); # ExtendedReportModel | Update existing report.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateReport(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling ReportsApi->updateReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ReportsApi()
body =  # ExtendedReportModel | Update existing report.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Update Report
    api_instance.update_report(body, authorization)
except ApiException as e:
    print("Exception when calling ReportsApi->updateReport: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


Rules

createRule

Create Rule

Add new rule


/rules

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//rules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RulesApi;

import java.io.File;
import java.util.*;

public class RulesApiExample {

    public static void main(String[] args) {
        
        RulesApi apiInstance = new RulesApi();
        RuleModel body = ; // RuleModel | Add new rule.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createRule(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#createRule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RulesApi;

public class RulesApiExample {

    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        RuleModel body = ; // RuleModel | Add new rule.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createRule(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#createRule");
            e.printStackTrace();
        }
    }
}
RuleModel *body = ; // Add new rule.
String *authorization = authorization_example; // Bearer JWT Token (default to )

RulesApi *apiInstance = [[RulesApi alloc] init];

// Create Rule
[apiInstance createRuleWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.RulesApi()

var body = ; // {RuleModel} Add new rule.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createRule(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createRuleExample
    {
        public void main()
        {
            
            var apiInstance = new RulesApi();
            var body = new RuleModel(); // RuleModel | Add new rule.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create Rule
                apiInstance.createRule(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RulesApi.createRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RulesApi();
$body = ; // RuleModel | Add new rule.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createRule($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling RulesApi->createRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RulesApi;

my $api_instance = WWW::SwaggerClient::RulesApi->new();
my $body = WWW::SwaggerClient::Object::RuleModel->new(); # RuleModel | Add new rule.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createRule(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling RulesApi->createRule: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RulesApi()
body =  # RuleModel | Add new rule.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create Rule
    api_instance.create_rule(body, authorization)
except ApiException as e:
    print("Exception when calling RulesApi->createRule: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deleteRule

Delete Rule

Delete existing rule


/rules/{ruleId}

Usage and SDK Samples

curl -X DELETE "http://localhost/codeinsight/api//rules/{ruleId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RulesApi;

import java.io.File;
import java.util.*;

public class RulesApiExample {

    public static void main(String[] args) {
        
        RulesApi apiInstance = new RulesApi();
        Long ruleId = 789; // Long | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteRule(ruleId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#deleteRule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RulesApi;

public class RulesApiExample {

    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        Long ruleId = 789; // Long | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deleteRule(ruleId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#deleteRule");
            e.printStackTrace();
        }
    }
}
Long *ruleId = 789; // 
String *authorization = authorization_example; // Bearer JWT Token (default to )

RulesApi *apiInstance = [[RulesApi alloc] init];

// Delete Rule
[apiInstance deleteRuleWith:ruleId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.RulesApi()

var ruleId = 789; // {Long} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteRule(ruleId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRuleExample
    {
        public void main()
        {
            
            var apiInstance = new RulesApi();
            var ruleId = 789;  // Long | 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Delete Rule
                apiInstance.deleteRule(ruleId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RulesApi.deleteRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RulesApi();
$ruleId = 789; // Long | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->deleteRule($ruleId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling RulesApi->deleteRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RulesApi;

my $api_instance = WWW::SwaggerClient::RulesApi->new();
my $ruleId = 789; # Long | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->deleteRule(ruleId => $ruleId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling RulesApi->deleteRule: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RulesApi()
ruleId = 789 # Long | 
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Delete Rule
    api_instance.delete_rule(ruleId, authorization)
except ApiException as e:
    print("Exception when calling RulesApi->deleteRule: %s\n" % e)

Parameters

Path parameters
Name Description
ruleId*
Long (int64)
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getRule

Get Rule By Id

Get existing rule by ruleId


/rules/{ruleId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//rules/{ruleId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RulesApi;

import java.io.File;
import java.util.*;

public class RulesApiExample {

    public static void main(String[] args) {
        
        RulesApi apiInstance = new RulesApi();
        Long ruleId = 789; // Long | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getRule(ruleId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getRule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RulesApi;

public class RulesApiExample {

    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        Long ruleId = 789; // Long | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getRule(ruleId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getRule");
            e.printStackTrace();
        }
    }
}
Long *ruleId = 789; // 
String *authorization = authorization_example; // Bearer JWT Token (default to )

RulesApi *apiInstance = [[RulesApi alloc] init];

// Get Rule By Id
[apiInstance getRuleWith:ruleId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.RulesApi()

var ruleId = 789; // {Long} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getRule(ruleId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRuleExample
    {
        public void main()
        {
            
            var apiInstance = new RulesApi();
            var ruleId = 789;  // Long | 
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Rule By Id
                apiInstance.getRule(ruleId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RulesApi.getRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RulesApi();
$ruleId = 789; // Long | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getRule($ruleId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling RulesApi->getRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RulesApi;

my $api_instance = WWW::SwaggerClient::RulesApi->new();
my $ruleId = 789; # Long | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getRule(ruleId => $ruleId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling RulesApi->getRule: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RulesApi()
ruleId = 789 # Long | 
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Rule By Id
    api_instance.get_rule(ruleId, authorization)
except ApiException as e:
    print("Exception when calling RulesApi->getRule: %s\n" % e)

Parameters

Path parameters
Name Description
ruleId*
Long (int64)
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


getRules

Get Rules

Get existing custom rules


/rules

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//rules?offset=&limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RulesApi;

import java.io.File;
import java.util.*;

public class RulesApiExample {

    public static void main(String[] args) {
        
        RulesApi apiInstance = new RulesApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        try {
            apiInstance.getRules(authorization, offset, limit);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getRules");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RulesApi;

public class RulesApiExample {

    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        try {
            apiInstance.getRules(authorization, offset, limit);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#getRules");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *offset = 56; // Index of the page to start with (optional) (default to 1)
Integer *limit = 56; // Number Of Records to fetch (optional) (default to 25)

RulesApi *apiInstance = [[RulesApi alloc] init];

// Get Rules
[apiInstance getRulesWith:authorization
    offset:offset
    limit:limit
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.RulesApi()

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'offset': 56, // {Integer} Index of the page to start with
  'limit': 56 // {Integer} Number Of Records to fetch
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getRules(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRulesExample
    {
        public void main()
        {
            
            var apiInstance = new RulesApi();
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var offset = 56;  // Integer | Index of the page to start with (optional)  (default to 1)
            var limit = 56;  // Integer | Number Of Records to fetch (optional)  (default to 25)

            try
            {
                // Get Rules
                apiInstance.getRules(authorization, offset, limit);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RulesApi.getRules: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RulesApi();
$authorization = authorization_example; // String | Bearer JWT Token
$offset = 56; // Integer | Index of the page to start with
$limit = 56; // Integer | Number Of Records to fetch

try {
    $api_instance->getRules($authorization, $offset, $limit);
} catch (Exception $e) {
    echo 'Exception when calling RulesApi->getRules: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RulesApi;

my $api_instance = WWW::SwaggerClient::RulesApi->new();
my $authorization = authorization_example; # String | Bearer JWT Token
my $offset = 56; # Integer | Index of the page to start with
my $limit = 56; # Integer | Number Of Records to fetch

eval { 
    $api_instance->getRules(authorization => $authorization, offset => $offset, limit => $limit);
};
if ($@) {
    warn "Exception when calling RulesApi->getRules: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RulesApi()
authorization = authorization_example # String | Bearer JWT Token (default to )
offset = 56 # Integer | Index of the page to start with (optional) (default to 1)
limit = 56 # Integer | Number Of Records to fetch (optional) (default to 25)

try: 
    # Get Rules
    api_instance.get_rules(authorization, offset=offset, limit=limit)
except ApiException as e:
    print("Exception when calling RulesApi->getRules: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
offset
Integer (int32)
Index of the page to start with
limit
Integer (int32)
Number Of Records to fetch

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


updateRule

Update Rule

Update existing rule


/rules

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//rules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RulesApi;

import java.io.File;
import java.util.*;

public class RulesApiExample {

    public static void main(String[] args) {
        
        RulesApi apiInstance = new RulesApi();
        ExtendedRuleModel body = ; // ExtendedRuleModel | Update existing rule.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateRule(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#updateRule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.RulesApi;

public class RulesApiExample {

    public static void main(String[] args) {
        RulesApi apiInstance = new RulesApi();
        ExtendedRuleModel body = ; // ExtendedRuleModel | Update existing rule.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateRule(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling RulesApi#updateRule");
            e.printStackTrace();
        }
    }
}
ExtendedRuleModel *body = ; // Update existing rule.
String *authorization = authorization_example; // Bearer JWT Token (default to )

RulesApi *apiInstance = [[RulesApi alloc] init];

// Update Rule
[apiInstance updateRuleWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.RulesApi()

var body = ; // {ExtendedRuleModel} Update existing rule.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateRule(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateRuleExample
    {
        public void main()
        {
            
            var apiInstance = new RulesApi();
            var body = new ExtendedRuleModel(); // ExtendedRuleModel | Update existing rule.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Update Rule
                apiInstance.updateRule(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RulesApi.updateRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\RulesApi();
$body = ; // ExtendedRuleModel | Update existing rule.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateRule($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling RulesApi->updateRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RulesApi;

my $api_instance = WWW::SwaggerClient::RulesApi->new();
my $body = WWW::SwaggerClient::Object::ExtendedRuleModel->new(); # ExtendedRuleModel | Update existing rule.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateRule(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling RulesApi->updateRule: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RulesApi()
body =  # ExtendedRuleModel | Update existing rule.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Update Rule
    api_instance.update_rule(body, authorization)
except ApiException as e:
    print("Exception when calling RulesApi->updateRule: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


ScanAPI

addProjectScanTask

Project Scan

Initiates a scan for a given project, specified by the projectId. Returns the taskId corresponding to the scan task. The taskId can be used to check the scan status. Only Project Admin and Analyst can invoke a scan of a project.


/scanResource/projectScan/{projectId}

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//scanResource/projectScan/{projectId}?fullRescan="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScanAPIApi;

import java.io.File;
import java.util.*;

public class ScanAPIApiExample {

    public static void main(String[] args) {
        
        ScanAPIApi apiInstance = new ScanAPIApi();
        Integer projectId = 56; // Integer | ID of the project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean fullRescan = true; // Boolean | Irrespective of codebase changes, pass value as true to perform a full scan of the codebase
        try {
            'Integer' result = apiInstance.addProjectScanTask(projectId, authorization, fullRescan);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScanAPIApi#addProjectScanTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScanAPIApi;

public class ScanAPIApiExample {

    public static void main(String[] args) {
        ScanAPIApi apiInstance = new ScanAPIApi();
        Integer projectId = 56; // Integer | ID of the project
        String authorization = authorization_example; // String | Bearer JWT Token
        Boolean fullRescan = true; // Boolean | Irrespective of codebase changes, pass value as true to perform a full scan of the codebase
        try {
            'Integer' result = apiInstance.addProjectScanTask(projectId, authorization, fullRescan);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScanAPIApi#addProjectScanTask");
            e.printStackTrace();
        }
    }
}
Integer *projectId = 56; // ID of the project
String *authorization = authorization_example; // Bearer JWT Token (default to )
Boolean *fullRescan = true; // Irrespective of codebase changes, pass value as true to perform a full scan of the codebase (optional)

ScanAPIApi *apiInstance = [[ScanAPIApi alloc] init];

// Project Scan
[apiInstance addProjectScanTaskWith:projectId
    authorization:authorization
    fullRescan:fullRescan
              completionHandler: ^('Integer' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.ScanAPIApi()

var projectId = 56; // {Integer} ID of the project

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'fullRescan': true // {Boolean} Irrespective of codebase changes, pass value as true to perform a full scan of the codebase
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addProjectScanTask(projectId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addProjectScanTaskExample
    {
        public void main()
        {
            
            var apiInstance = new ScanAPIApi();
            var projectId = 56;  // Integer | ID of the project
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var fullRescan = true;  // Boolean | Irrespective of codebase changes, pass value as true to perform a full scan of the codebase (optional) 

            try
            {
                // Project Scan
                'Integer' result = apiInstance.addProjectScanTask(projectId, authorization, fullRescan);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScanAPIApi.addProjectScanTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ScanAPIApi();
$projectId = 56; // Integer | ID of the project
$authorization = authorization_example; // String | Bearer JWT Token
$fullRescan = true; // Boolean | Irrespective of codebase changes, pass value as true to perform a full scan of the codebase

try {
    $result = $api_instance->addProjectScanTask($projectId, $authorization, $fullRescan);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScanAPIApi->addProjectScanTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScanAPIApi;

my $api_instance = WWW::SwaggerClient::ScanAPIApi->new();
my $projectId = 56; # Integer | ID of the project
my $authorization = authorization_example; # String | Bearer JWT Token
my $fullRescan = true; # Boolean | Irrespective of codebase changes, pass value as true to perform a full scan of the codebase

eval { 
    my $result = $api_instance->addProjectScanTask(projectId => $projectId, authorization => $authorization, fullRescan => $fullRescan);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScanAPIApi->addProjectScanTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScanAPIApi()
projectId = 56 # Integer | ID of the project
authorization = authorization_example # String | Bearer JWT Token (default to )
fullRescan = true # Boolean | Irrespective of codebase changes, pass value as true to perform a full scan of the codebase (optional)

try: 
    # Project Scan
    api_response = api_instance.add_project_scan_task(projectId, authorization, fullRescan=fullRescan)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScanAPIApi->addProjectScanTask: %s\n" % e)

Parameters

Path parameters
Name Description
projectId*
Integer (int32)
ID of the project
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
fullRescan
Boolean
Irrespective of codebase changes, pass value as true to perform a full scan of the codebase

Responses

Status: 200 - OK

Status: 400 - Bad request: The project Id entered was not found


Task

assignAlmIssuesToTask

Assign Alm Issues

Assign Alm Issues to task


/tasks/{taskId}/issues

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//tasks/{taskId}/issues"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

import java.io.File;
import java.util.*;

public class TaskApiExample {

    public static void main(String[] args) {
        
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be updated
        AlmIssues body = ; // AlmIssues | Map alm Issues to workflow task
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.assignAlmIssuesToTask(taskId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#assignAlmIssuesToTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be updated
        AlmIssues body = ; // AlmIssues | Map alm Issues to workflow task
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.assignAlmIssuesToTask(taskId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#assignAlmIssuesToTask");
            e.printStackTrace();
        }
    }
}
Integer *taskId = 56; // ID of the task to be updated
AlmIssues *body = ; // Map alm Issues to workflow task
String *authorization = authorization_example; // Bearer JWT Token (default to )

TaskApi *apiInstance = [[TaskApi alloc] init];

// Assign Alm Issues
[apiInstance assignAlmIssuesToTaskWith:taskId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.TaskApi()

var taskId = 56; // {Integer} ID of the task to be updated

var body = ; // {AlmIssues} Map alm Issues to workflow task

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.assignAlmIssuesToTask(taskId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assignAlmIssuesToTaskExample
    {
        public void main()
        {
            
            var apiInstance = new TaskApi();
            var taskId = 56;  // Integer | ID of the task to be updated
            var body = new AlmIssues(); // AlmIssues | Map alm Issues to workflow task
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Assign Alm Issues
                apiInstance.assignAlmIssuesToTask(taskId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.assignAlmIssuesToTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskApi();
$taskId = 56; // Integer | ID of the task to be updated
$body = ; // AlmIssues | Map alm Issues to workflow task
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->assignAlmIssuesToTask($taskId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->assignAlmIssuesToTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $taskId = 56; # Integer | ID of the task to be updated
my $body = WWW::SwaggerClient::Object::AlmIssues->new(); # AlmIssues | Map alm Issues to workflow task
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->assignAlmIssuesToTask(taskId => $taskId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling TaskApi->assignAlmIssuesToTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskApi()
taskId = 56 # Integer | ID of the task to be updated
body =  # AlmIssues | Map alm Issues to workflow task
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Assign Alm Issues
    api_instance.assign_alm_issues_to_task(taskId, body, authorization)
except ApiException as e:
    print("Exception when calling TaskApi->assignAlmIssuesToTask: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Integer (int32)
ID of the task to be updated
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


closeTask

Close Task

Close Task


/tasks/{taskId}/close

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//tasks/{taskId}/close?resolution="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

import java.io.File;
import java.util.*;

public class TaskApiExample {

    public static void main(String[] args) {
        
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be closed
        String resolution = resolution_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.closeTask(taskId, resolution, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#closeTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be closed
        String resolution = resolution_example; // String | 
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.closeTask(taskId, resolution, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#closeTask");
            e.printStackTrace();
        }
    }
}
Integer *taskId = 56; // ID of the task to be closed
String *resolution = resolution_example; //  (default to CLOSED)
String *authorization = authorization_example; // Bearer JWT Token (default to )

TaskApi *apiInstance = [[TaskApi alloc] init];

// Close Task
[apiInstance closeTaskWith:taskId
    resolution:resolution
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.TaskApi()

var taskId = 56; // {Integer} ID of the task to be closed

var resolution = resolution_example; // {String} 

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.closeTask(taskId, resolution, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class closeTaskExample
    {
        public void main()
        {
            
            var apiInstance = new TaskApi();
            var taskId = 56;  // Integer | ID of the task to be closed
            var resolution = resolution_example;  // String |  (default to CLOSED)
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Close Task
                apiInstance.closeTask(taskId, resolution, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.closeTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskApi();
$taskId = 56; // Integer | ID of the task to be closed
$resolution = resolution_example; // String | 
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->closeTask($taskId, $resolution, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->closeTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $taskId = 56; # Integer | ID of the task to be closed
my $resolution = resolution_example; # String | 
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->closeTask(taskId => $taskId, resolution => $resolution, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling TaskApi->closeTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskApi()
taskId = 56 # Integer | ID of the task to be closed
resolution = resolution_example # String |  (default to CLOSED)
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Close Task
    api_instance.close_task(taskId, resolution, authorization)
except ApiException as e:
    print("Exception when calling TaskApi->closeTask: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Integer (int32)
ID of the task to be closed
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
resolution*
String
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


createTask

Create Task

Create Task


/tasks

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//tasks?inventoryId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

import java.io.File;
import java.util.*;

public class TaskApiExample {

    public static void main(String[] args) {
        
        TaskApi apiInstance = new TaskApi();
        Integer inventoryId = 56; // Integer | ID of the inventory to be used to create the task
        WorkflowTaskModel body = ; // WorkflowTaskModel | Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createTask(inventoryId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#createTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        Integer inventoryId = 56; // Integer | ID of the inventory to be used to create the task
        WorkflowTaskModel body = ; // WorkflowTaskModel | Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createTask(inventoryId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#createTask");
            e.printStackTrace();
        }
    }
}
Integer *inventoryId = 56; // ID of the inventory to be used to create the task
WorkflowTaskModel *body = ; // Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"
String *authorization = authorization_example; // Bearer JWT Token (default to )

TaskApi *apiInstance = [[TaskApi alloc] init];

// Create Task
[apiInstance createTaskWith:inventoryId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.TaskApi()

var inventoryId = 56; // {Integer} ID of the inventory to be used to create the task

var body = ; // {WorkflowTaskModel} Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createTask(inventoryId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTaskExample
    {
        public void main()
        {
            
            var apiInstance = new TaskApi();
            var inventoryId = 56;  // Integer | ID of the inventory to be used to create the task
            var body = new WorkflowTaskModel(); // WorkflowTaskModel | Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create Task
                apiInstance.createTask(inventoryId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.createTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskApi();
$inventoryId = 56; // Integer | ID of the inventory to be used to create the task
$body = ; // WorkflowTaskModel | Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createTask($inventoryId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->createTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $inventoryId = 56; # Integer | ID of the inventory to be used to create the task
my $body = WWW::SwaggerClient::Object::WorkflowTaskModel->new(); # WorkflowTaskModel | Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createTask(inventoryId => $inventoryId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling TaskApi->createTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskApi()
inventoryId = 56 # Integer | ID of the inventory to be used to create the task
body =  # WorkflowTaskModel | Create new workflow task 	
 priority :"LOW, MEDIUM, HIGH" 
 type : "MISCELLANEOUS, MANUAL_INVENTORY_REVIEW, REMEDIATE_INVENTORY"
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create Task
    api_instance.create_task(inventoryId, body, authorization)
except ApiException as e:
    print("Exception when calling TaskApi->createTask: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *
Query parameters
Name Description
inventoryId*
Integer (int32)
ID of the inventory to be used to create the task
Required

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


getTask

Get Task

Get Task


/tasks/{taskId}

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//tasks/{taskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

import java.io.File;
import java.util.*;

public class TaskApiExample {

    public static void main(String[] args) {
        
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be fetched
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getTask(taskId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#getTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be fetched
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.getTask(taskId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#getTask");
            e.printStackTrace();
        }
    }
}
Integer *taskId = 56; // ID of the task to be fetched
String *authorization = authorization_example; // Bearer JWT Token (default to )

TaskApi *apiInstance = [[TaskApi alloc] init];

// Get Task
[apiInstance getTaskWith:taskId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.TaskApi()

var taskId = 56; // {Integer} ID of the task to be fetched

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getTask(taskId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTaskExample
    {
        public void main()
        {
            
            var apiInstance = new TaskApi();
            var taskId = 56;  // Integer | ID of the task to be fetched
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Get Task
                apiInstance.getTask(taskId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.getTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskApi();
$taskId = 56; // Integer | ID of the task to be fetched
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->getTask($taskId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->getTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $taskId = 56; # Integer | ID of the task to be fetched
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->getTask(taskId => $taskId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling TaskApi->getTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskApi()
taskId = 56 # Integer | ID of the task to be fetched
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Get Task
    api_instance.get_task(taskId, authorization)
except ApiException as e:
    print("Exception when calling TaskApi->getTask: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Integer (int32)
ID of the task to be fetched
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


reassignTask

Reassign Task

Reassign Task


/tasks/{taskId}/reassign

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//tasks/{taskId}/reassign?ownerId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

import java.io.File;
import java.util.*;

public class TaskApiExample {

    public static void main(String[] args) {
        
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be reassigned
        String ownerId = ownerId_example; // String | ID / Name of the owner to whom the task needs to be reassigned
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.reassignTask(taskId, ownerId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#reassignTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be reassigned
        String ownerId = ownerId_example; // String | ID / Name of the owner to whom the task needs to be reassigned
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.reassignTask(taskId, ownerId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#reassignTask");
            e.printStackTrace();
        }
    }
}
Integer *taskId = 56; // ID of the task to be reassigned
String *ownerId = ownerId_example; // ID / Name of the owner to whom the task needs to be reassigned
String *authorization = authorization_example; // Bearer JWT Token (default to )

TaskApi *apiInstance = [[TaskApi alloc] init];

// Reassign Task
[apiInstance reassignTaskWith:taskId
    ownerId:ownerId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.TaskApi()

var taskId = 56; // {Integer} ID of the task to be reassigned

var ownerId = ownerId_example; // {String} ID / Name of the owner to whom the task needs to be reassigned

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.reassignTask(taskId, ownerId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class reassignTaskExample
    {
        public void main()
        {
            
            var apiInstance = new TaskApi();
            var taskId = 56;  // Integer | ID of the task to be reassigned
            var ownerId = ownerId_example;  // String | ID / Name of the owner to whom the task needs to be reassigned
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Reassign Task
                apiInstance.reassignTask(taskId, ownerId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.reassignTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskApi();
$taskId = 56; // Integer | ID of the task to be reassigned
$ownerId = ownerId_example; // String | ID / Name of the owner to whom the task needs to be reassigned
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->reassignTask($taskId, $ownerId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->reassignTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $taskId = 56; # Integer | ID of the task to be reassigned
my $ownerId = ownerId_example; # String | ID / Name of the owner to whom the task needs to be reassigned
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->reassignTask(taskId => $taskId, ownerId => $ownerId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling TaskApi->reassignTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskApi()
taskId = 56 # Integer | ID of the task to be reassigned
ownerId = ownerId_example # String | ID / Name of the owner to whom the task needs to be reassigned
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Reassign Task
    api_instance.reassign_task(taskId, ownerId, authorization)
except ApiException as e:
    print("Exception when calling TaskApi->reassignTask: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Integer (int32)
ID of the task to be reassigned
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
ownerId*
String
ID / Name of the owner to whom the task needs to be reassigned
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


searchTask

Get Tasks based on the search Terms

Return Tasks associated with the search term


/tasks/search

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//tasks/search?projectId=&inventoryId=&offset=&limit=&status=&type=&priority="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

import java.io.File;
import java.util.*;

public class TaskApiExample {

    public static void main(String[] args) {
        
        TaskApi apiInstance = new TaskApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer projectId = 56; // Integer | ID of the Project to be used in search
        Integer inventoryId = 56; // Integer | ID of the inventory to be used in search
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        String status = status_example; // String | Status of the Task to be used in search
        String type = type_example; // String | Type of the Task to be used in search
        String priority = priority_example; // String | Priority of the Task to be used in search
        try {
            apiInstance.searchTask(authorization, projectId, inventoryId, offset, limit, status, type, priority);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#searchTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer projectId = 56; // Integer | ID of the Project to be used in search
        Integer inventoryId = 56; // Integer | ID of the inventory to be used in search
        Integer offset = 56; // Integer | Index of the page to start with
        Integer limit = 56; // Integer | Number Of Records to fetch
        String status = status_example; // String | Status of the Task to be used in search
        String type = type_example; // String | Type of the Task to be used in search
        String priority = priority_example; // String | Priority of the Task to be used in search
        try {
            apiInstance.searchTask(authorization, projectId, inventoryId, offset, limit, status, type, priority);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#searchTask");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *projectId = 56; // ID of the Project to be used in search (optional)
Integer *inventoryId = 56; // ID of the inventory to be used in search (optional)
Integer *offset = 56; // Index of the page to start with (optional) (default to 1)
Integer *limit = 56; // Number Of Records to fetch (optional) (default to 25)
String *status = status_example; // Status of the Task to be used in search (optional) (default to ALL)
String *type = type_example; // Type of the Task to be used in search (optional) (default to ALL)
String *priority = priority_example; // Priority of the Task to be used in search (optional) (default to ALL)

TaskApi *apiInstance = [[TaskApi alloc] init];

// Get Tasks based on the search Terms
[apiInstance searchTaskWith:authorization
    projectId:projectId
    inventoryId:inventoryId
    offset:offset
    limit:limit
    status:status
    type:type
    priority:priority
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.TaskApi()

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'projectId': 56, // {Integer} ID of the Project to be used in search
  'inventoryId': 56, // {Integer} ID of the inventory to be used in search
  'offset': 56, // {Integer} Index of the page to start with
  'limit': 56, // {Integer} Number Of Records to fetch
  'status': status_example, // {String} Status of the Task to be used in search
  'type': type_example, // {String} Type of the Task to be used in search
  'priority': priority_example // {String} Priority of the Task to be used in search
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchTask(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchTaskExample
    {
        public void main()
        {
            
            var apiInstance = new TaskApi();
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var projectId = 56;  // Integer | ID of the Project to be used in search (optional) 
            var inventoryId = 56;  // Integer | ID of the inventory to be used in search (optional) 
            var offset = 56;  // Integer | Index of the page to start with (optional)  (default to 1)
            var limit = 56;  // Integer | Number Of Records to fetch (optional)  (default to 25)
            var status = status_example;  // String | Status of the Task to be used in search (optional)  (default to ALL)
            var type = type_example;  // String | Type of the Task to be used in search (optional)  (default to ALL)
            var priority = priority_example;  // String | Priority of the Task to be used in search (optional)  (default to ALL)

            try
            {
                // Get Tasks based on the search Terms
                apiInstance.searchTask(authorization, projectId, inventoryId, offset, limit, status, type, priority);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.searchTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskApi();
$authorization = authorization_example; // String | Bearer JWT Token
$projectId = 56; // Integer | ID of the Project to be used in search
$inventoryId = 56; // Integer | ID of the inventory to be used in search
$offset = 56; // Integer | Index of the page to start with
$limit = 56; // Integer | Number Of Records to fetch
$status = status_example; // String | Status of the Task to be used in search
$type = type_example; // String | Type of the Task to be used in search
$priority = priority_example; // String | Priority of the Task to be used in search

try {
    $api_instance->searchTask($authorization, $projectId, $inventoryId, $offset, $limit, $status, $type, $priority);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->searchTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $authorization = authorization_example; # String | Bearer JWT Token
my $projectId = 56; # Integer | ID of the Project to be used in search
my $inventoryId = 56; # Integer | ID of the inventory to be used in search
my $offset = 56; # Integer | Index of the page to start with
my $limit = 56; # Integer | Number Of Records to fetch
my $status = status_example; # String | Status of the Task to be used in search
my $type = type_example; # String | Type of the Task to be used in search
my $priority = priority_example; # String | Priority of the Task to be used in search

eval { 
    $api_instance->searchTask(authorization => $authorization, projectId => $projectId, inventoryId => $inventoryId, offset => $offset, limit => $limit, status => $status, type => $type, priority => $priority);
};
if ($@) {
    warn "Exception when calling TaskApi->searchTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskApi()
authorization = authorization_example # String | Bearer JWT Token (default to )
projectId = 56 # Integer | ID of the Project to be used in search (optional)
inventoryId = 56 # Integer | ID of the inventory to be used in search (optional)
offset = 56 # Integer | Index of the page to start with (optional) (default to 1)
limit = 56 # Integer | Number Of Records to fetch (optional) (default to 25)
status = status_example # String | Status of the Task to be used in search (optional) (default to ALL)
type = type_example # String | Type of the Task to be used in search (optional) (default to ALL)
priority = priority_example # String | Priority of the Task to be used in search (optional) (default to ALL)

try: 
    # Get Tasks based on the search Terms
    api_instance.search_task(authorization, projectId=projectId, inventoryId=inventoryId, offset=offset, limit=limit, status=status, type=type, priority=priority)
except ApiException as e:
    print("Exception when calling TaskApi->searchTask: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
projectId
Integer (int32)
ID of the Project to be used in search
inventoryId
Integer (int32)
ID of the inventory to be used in search
offset
Integer (int32)
Index of the page to start with
limit
Integer (int32)
Number Of Records to fetch
status
String
Status of the Task to be used in search
type
String
Type of the Task to be used in search
priority
String
Priority of the Task to be used in search

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


updateTask

Update Task

Update Task


/tasks/{taskId}

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//tasks/{taskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TaskApi;

import java.io.File;
import java.util.*;

public class TaskApiExample {

    public static void main(String[] args) {
        
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be updated
        ExtendedWorkflowTaskModel body = ; // ExtendedWorkflowTaskModel | Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateTask(taskId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#updateTask");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TaskApi;

public class TaskApiExample {

    public static void main(String[] args) {
        TaskApi apiInstance = new TaskApi();
        Integer taskId = 56; // Integer | ID of the task to be updated
        ExtendedWorkflowTaskModel body = ; // ExtendedWorkflowTaskModel | Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.updateTask(taskId, body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling TaskApi#updateTask");
            e.printStackTrace();
        }
    }
}
Integer *taskId = 56; // ID of the task to be updated
ExtendedWorkflowTaskModel *body = ; // Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"
String *authorization = authorization_example; // Bearer JWT Token (default to )

TaskApi *apiInstance = [[TaskApi alloc] init];

// Update Task
[apiInstance updateTaskWith:taskId
    body:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.TaskApi()

var taskId = 56; // {Integer} ID of the task to be updated

var body = ; // {ExtendedWorkflowTaskModel} Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateTask(taskId, body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateTaskExample
    {
        public void main()
        {
            
            var apiInstance = new TaskApi();
            var taskId = 56;  // Integer | ID of the task to be updated
            var body = new ExtendedWorkflowTaskModel(); // ExtendedWorkflowTaskModel | Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Update Task
                apiInstance.updateTask(taskId, body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TaskApi.updateTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\TaskApi();
$taskId = 56; // Integer | ID of the task to be updated
$body = ; // ExtendedWorkflowTaskModel | Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->updateTask($taskId, $body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling TaskApi->updateTask: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TaskApi;

my $api_instance = WWW::SwaggerClient::TaskApi->new();
my $taskId = 56; # Integer | ID of the task to be updated
my $body = WWW::SwaggerClient::Object::ExtendedWorkflowTaskModel->new(); # ExtendedWorkflowTaskModel | Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->updateTask(taskId => $taskId, body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling TaskApi->updateTask: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TaskApi()
taskId = 56 # Integer | ID of the task to be updated
body =  # ExtendedWorkflowTaskModel | Update existing workflow task 	
 priority :"LOW, MEDIUM, HIGH"
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Update Task
    api_instance.update_task(taskId, body, authorization)
except ApiException as e:
    print("Exception when calling TaskApi->updateTask: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Integer (int32)
ID of the task to be updated
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error


UserAPI

activateUser

activate User

Activate a User


/users/{loginId}/activate

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//users/{loginId}/activate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAPIApi;

import java.io.File;
import java.util.*;

public class UserAPIApiExample {

    public static void main(String[] args) {
        
        UserAPIApi apiInstance = new UserAPIApi();
        String loginId = loginId_example; // String | loginId
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.activateUser(loginId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#activateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAPIApi;

public class UserAPIApiExample {

    public static void main(String[] args) {
        UserAPIApi apiInstance = new UserAPIApi();
        String loginId = loginId_example; // String | loginId
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.activateUser(loginId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#activateUser");
            e.printStackTrace();
        }
    }
}
String *loginId = loginId_example; // loginId
String *authorization = authorization_example; // Bearer JWT Token (default to )

UserAPIApi *apiInstance = [[UserAPIApi alloc] init];

// activate User
[apiInstance activateUserWith:loginId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.UserAPIApi()

var loginId = loginId_example; // {String} loginId

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.activateUser(loginId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class activateUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserAPIApi();
            var loginId = loginId_example;  // String | loginId
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // activate User
                apiInstance.activateUser(loginId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAPIApi.activateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAPIApi();
$loginId = loginId_example; // String | loginId
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->activateUser($loginId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling UserAPIApi->activateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserAPIApi;

my $api_instance = WWW::SwaggerClient::UserAPIApi->new();
my $loginId = loginId_example; # String | loginId
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->activateUser(loginId => $loginId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UserAPIApi->activateUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserAPIApi()
loginId = loginId_example # String | loginId
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # activate User
    api_instance.activate_user(loginId, authorization)
except ApiException as e:
    print("Exception when calling UserAPIApi->activateUser: %s\n" % e)

Parameters

Path parameters
Name Description
loginId*
String
loginId
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found


createUser

Create User

Creates a user


/users

Usage and SDK Samples

curl -X POST "http://localhost/codeinsight/api//users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAPIApi;

import java.io.File;
import java.util.*;

public class UserAPIApiExample {

    public static void main(String[] args) {
        
        UserAPIApi apiInstance = new UserAPIApi();
        UserModel body = ; // UserModel | To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createUser(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#createUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAPIApi;

public class UserAPIApiExample {

    public static void main(String[] args) {
        UserAPIApi apiInstance = new UserAPIApi();
        UserModel body = ; // UserModel | To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.createUser(body, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#createUser");
            e.printStackTrace();
        }
    }
}
UserModel *body = ; // To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.
String *authorization = authorization_example; // Bearer JWT Token (default to )

UserAPIApi *apiInstance = [[UserAPIApi alloc] init];

// Create User
[apiInstance createUserWith:body
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.UserAPIApi()

var body = ; // {UserModel} To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUser(body, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserAPIApi();
            var body = new UserModel(); // UserModel | To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // Create User
                apiInstance.createUser(body, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAPIApi.createUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAPIApi();
$body = ; // UserModel | To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->createUser($body, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling UserAPIApi->createUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserAPIApi;

my $api_instance = WWW::SwaggerClient::UserAPIApi->new();
my $body = WWW::SwaggerClient::Object::UserModel->new(); # UserModel | To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->createUser(body => $body, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UserAPIApi->createUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserAPIApi()
body =  # UserModel | To create a user the login, First Name, Last Name, Email, Password, Question, Answer field is required.
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # Create User
    api_instance.create_user(body, authorization)
except ApiException as e:
    print("Exception when calling UserAPIApi->createUser: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body *

Responses

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 500 - Internal Server Error


deactivateUser

deactivate User

Deactivate a User


/users/{loginId}/deactivate

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//users/{loginId}/deactivate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAPIApi;

import java.io.File;
import java.util.*;

public class UserAPIApiExample {

    public static void main(String[] args) {
        
        UserAPIApi apiInstance = new UserAPIApi();
        String loginId = loginId_example; // String | loginId
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deactivateUser(loginId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#deactivateUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAPIApi;

public class UserAPIApiExample {

    public static void main(String[] args) {
        UserAPIApi apiInstance = new UserAPIApi();
        String loginId = loginId_example; // String | loginId
        String authorization = authorization_example; // String | Bearer JWT Token
        try {
            apiInstance.deactivateUser(loginId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#deactivateUser");
            e.printStackTrace();
        }
    }
}
String *loginId = loginId_example; // loginId
String *authorization = authorization_example; // Bearer JWT Token (default to )

UserAPIApi *apiInstance = [[UserAPIApi alloc] init];

// deactivate User
[apiInstance deactivateUserWith:loginId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.UserAPIApi()

var loginId = loginId_example; // {String} loginId

var authorization = authorization_example; // {String} Bearer JWT Token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deactivateUser(loginId, authorization, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deactivateUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserAPIApi();
            var loginId = loginId_example;  // String | loginId
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )

            try
            {
                // deactivate User
                apiInstance.deactivateUser(loginId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAPIApi.deactivateUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAPIApi();
$loginId = loginId_example; // String | loginId
$authorization = authorization_example; // String | Bearer JWT Token

try {
    $api_instance->deactivateUser($loginId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling UserAPIApi->deactivateUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserAPIApi;

my $api_instance = WWW::SwaggerClient::UserAPIApi->new();
my $loginId = loginId_example; # String | loginId
my $authorization = authorization_example; # String | Bearer JWT Token

eval { 
    $api_instance->deactivateUser(loginId => $loginId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling UserAPIApi->deactivateUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserAPIApi()
loginId = loginId_example # String | loginId
authorization = authorization_example # String | Bearer JWT Token (default to )

try: 
    # deactivate User
    api_instance.deactivate_user(loginId, authorization)
except ApiException as e:
    print("Exception when calling UserAPIApi->deactivateUser: %s\n" % e)

Parameters

Path parameters
Name Description
loginId*
String
loginId
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found


managePermission

manage Permission

Manage User Permission for the existing user in the system. This will remove the permission mapped earlier and the current request permissions will be considered always.


/users/{loginId}/permission

Usage and SDK Samples

curl -X PUT "http://localhost/codeinsight/api//users/{loginId}/permission"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAPIApi;

import java.io.File;
import java.util.*;

public class UserAPIApiExample {

    public static void main(String[] args) {
        
        UserAPIApi apiInstance = new UserAPIApi();
        String loginId = loginId_example; // String | loginId
        String authorization = authorization_example; // String | Bearer JWT Token
        PermissionsWrapper body = ; // PermissionsWrapper | list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project
        try {
            apiInstance.managePermission(loginId, authorization, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#managePermission");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAPIApi;

public class UserAPIApiExample {

    public static void main(String[] args) {
        UserAPIApi apiInstance = new UserAPIApi();
        String loginId = loginId_example; // String | loginId
        String authorization = authorization_example; // String | Bearer JWT Token
        PermissionsWrapper body = ; // PermissionsWrapper | list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project
        try {
            apiInstance.managePermission(loginId, authorization, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#managePermission");
            e.printStackTrace();
        }
    }
}
String *loginId = loginId_example; // loginId
String *authorization = authorization_example; // Bearer JWT Token (default to )
PermissionsWrapper *body = ; // list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project (optional)

UserAPIApi *apiInstance = [[UserAPIApi alloc] init];

// manage Permission
[apiInstance managePermissionWith:loginId
    authorization:authorization
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.UserAPIApi()

var loginId = loginId_example; // {String} loginId

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'body':  // {PermissionsWrapper} list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.managePermission(loginId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class managePermissionExample
    {
        public void main()
        {
            
            var apiInstance = new UserAPIApi();
            var loginId = loginId_example;  // String | loginId
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var body = new PermissionsWrapper(); // PermissionsWrapper | list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project (optional) 

            try
            {
                // manage Permission
                apiInstance.managePermission(loginId, authorization, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAPIApi.managePermission: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAPIApi();
$loginId = loginId_example; // String | loginId
$authorization = authorization_example; // String | Bearer JWT Token
$body = ; // PermissionsWrapper | list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project

try {
    $api_instance->managePermission($loginId, $authorization, $body);
} catch (Exception $e) {
    echo 'Exception when calling UserAPIApi->managePermission: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserAPIApi;

my $api_instance = WWW::SwaggerClient::UserAPIApi->new();
my $loginId = loginId_example; # String | loginId
my $authorization = authorization_example; # String | Bearer JWT Token
my $body = WWW::SwaggerClient::Object::PermissionsWrapper->new(); # PermissionsWrapper | list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project

eval { 
    $api_instance->managePermission(loginId => $loginId, authorization => $authorization, body => $body);
};
if ($@) {
    warn "Exception when calling UserAPIApi->managePermission: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserAPIApi()
loginId = loginId_example # String | loginId
authorization = authorization_example # String | Bearer JWT Token (default to )
body =  # PermissionsWrapper | list of permission is a required field. Allowable permission are system_admin, edit_policy, create_project (optional)

try: 
    # manage Permission
    api_instance.manage_permission(loginId, authorization, body=body)
except ApiException as e:
    print("Exception when calling UserAPIApi->managePermission: %s\n" % e)

Parameters

Path parameters
Name Description
loginId*
String
loginId
Required
Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Body parameters
Name Description
body

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found


searchUser

Search Users

Search User By id or login


/users/search

Usage and SDK Samples

curl -X GET "http://localhost/codeinsight/api//users/search?id=&login=&email="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UserAPIApi;

import java.io.File;
import java.util.*;

public class UserAPIApiExample {

    public static void main(String[] args) {
        
        UserAPIApi apiInstance = new UserAPIApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer id = 56; // Integer | 
        String login = login_example; // String | 
        String email = email_example; // String | 
        try {
            apiInstance.searchUser(authorization, id, login, email);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#searchUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UserAPIApi;

public class UserAPIApiExample {

    public static void main(String[] args) {
        UserAPIApi apiInstance = new UserAPIApi();
        String authorization = authorization_example; // String | Bearer JWT Token
        Integer id = 56; // Integer | 
        String login = login_example; // String | 
        String email = email_example; // String | 
        try {
            apiInstance.searchUser(authorization, id, login, email);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserAPIApi#searchUser");
            e.printStackTrace();
        }
    }
}
String *authorization = authorization_example; // Bearer JWT Token (default to )
Integer *id = 56; //  (optional)
String *login = login_example; //  (optional)
String *email = email_example; //  (optional)

UserAPIApi *apiInstance = [[UserAPIApi alloc] init];

// Search Users
[apiInstance searchUserWith:authorization
    id:id
    login:login
    email:email
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CodeInsightRestApiDocumentation = require('code_insight_rest_api_documentation');

var api = new CodeInsightRestApiDocumentation.UserAPIApi()

var authorization = authorization_example; // {String} Bearer JWT Token

var opts = { 
  'id': 56, // {Integer} 
  'login': login_example, // {String} 
  'email': email_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchUser(authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchUserExample
    {
        public void main()
        {
            
            var apiInstance = new UserAPIApi();
            var authorization = authorization_example;  // String | Bearer JWT Token (default to )
            var id = 56;  // Integer |  (optional) 
            var login = login_example;  // String |  (optional) 
            var email = email_example;  // String |  (optional) 

            try
            {
                // Search Users
                apiInstance.searchUser(authorization, id, login, email);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UserAPIApi.searchUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\UserAPIApi();
$authorization = authorization_example; // String | Bearer JWT Token
$id = 56; // Integer | 
$login = login_example; // String | 
$email = email_example; // String | 

try {
    $api_instance->searchUser($authorization, $id, $login, $email);
} catch (Exception $e) {
    echo 'Exception when calling UserAPIApi->searchUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UserAPIApi;

my $api_instance = WWW::SwaggerClient::UserAPIApi->new();
my $authorization = authorization_example; # String | Bearer JWT Token
my $id = 56; # Integer | 
my $login = login_example; # String | 
my $email = email_example; # String | 

eval { 
    $api_instance->searchUser(authorization => $authorization, id => $id, login => $login, email => $email);
};
if ($@) {
    warn "Exception when calling UserAPIApi->searchUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.UserAPIApi()
authorization = authorization_example # String | Bearer JWT Token (default to )
id = 56 # Integer |  (optional)
login = login_example # String |  (optional)
email = email_example # String |  (optional)

try: 
    # Search Users
    api_instance.search_user(authorization, id=id, login=login, email=email)
except ApiException as e:
    print("Exception when calling UserAPIApi->searchUser: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer JWT Token
Required
Query parameters
Name Description
id
Integer (int32)
login
String
email
String

Responses

Status: 200 - OK

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 500 - Internal Server Error