CCPQD Reference

Parameter Description Default Options
disclosure
Optional
Disclosure 0.0 , 12.1 , 12.2 , 13.1 , 14.1 , 15.1 , 15.2 , 15.3 , 16.1 , 16.2 , 16.3 , 17.1 , 17.2 , 17.3 , 17.4 , 18.1 , 18.2 , 18.3 , 18.4 , 19.1 , 20.1 , 20.2 , 20.3 , 20.4 , 20.5 , 20.6 , 20.7 , 23.1 , 23.2 , 23.3 , 4.1 , 4.2 , 4.3 , 4.4 , 5.1 , 5.2 , 5.3 , 6.1 , 6.2 , 6.3 , 6.4 , 6.5 , 6.6 , 6.7 , 6.8 , 7.1 , 7.2 , 7.3
disclosureReference
Optional
Disclosure Reference 0.0.0 , 12.1.1 , 12.1.2 , 12.1.3 , 12.2.1 , 12.2.2 , 12.2.3 , 13.1.1 , 13.1.2 , 13.1.3.1 , 13.1.3.2 , 13.1.4 , 14.1.1 , 14.1.2 , 14.1.3 , 14.1.4 , 15.1.1 , 15.1.2 , 15.2.1 , 15.2.2 , 15.2.3 , 15.2.4 , 15.2.5 , 15.2.6 , 15.2.7 , 15.3.1 , 15.3.2 , 16.1.1 , 16.1.2 , 16.2.1 , 16.2.10 , 16.2.11 , 16.2.12 , 16.2.13 , 16.2.14 , 16.2.15 , 16.2.16 , 16.2.17 , 16.2.18 , 16.2.19 , 16.2.2 , 16.2.20 , 16.2.3 , 16.2.4 , 16.2.5 , 16.2.6 , 16.2.7 , 16.2.8 , 16.2.9 , 16.3.1 , 16.3.2 , 16.3.3 , 16.3.4 , 17.1.1 , 17.2.1 , 17.3.1 , 17.4.1 , 18.1.1.1 , 18.1.1.2 , 18.1.1.3 , 18.1.2.1 , 18.1.2.2 , 18.1.2.3 , 18.1.2.4 , 18.1.3.1 , 18.1.3.2 , 18.2.1 , 18.2.2 , 18.2.3 , 18.3.1 , 18.3.2 , 18.3.3 , 18.4.1 , 18.4.2 , 18.4.3 , 19.1.1 , 19.1.2 , 19.1.3.1 , 19.1.3.2 , 19.1.4.1 , 19.1.4.2 , 20.1.1 , 20.2.1 , 20.3.1 , 20.4.1.1 , 20.4.1.2 , 20.4.1.3 , 20.4.2 , 20.4.3 , 20.5.1.1 , 20.5.1.2 , 20.6.1.1 , 20.6.1.2 , 20.7.1 , 20.7.2 , 23.1.1 , 23.1.2 , 23.2.1 , 23.2.2 , 23.2.3 , 23.2.4 , 23.3.1 , 23.3.2 , 4.1.1 , 4.1.10 , 4.1.2 , 4.1.3 , 4.1.4 , 4.1.5 , 4.1.6 , 4.1.7 , 4.1.8 , 4.1.9 , 4.2.1 , 4.3.1 , 4.3.10 , 4.3.11 , 4.3.12 , 4.3.13 , 4.3.14 , 4.3.15 , 4.3.2 , 4.3.3 , 4.3.4 , 4.3.5 , 4.3.6 , 4.3.7 , 4.3.8 , 4.3.9 , 4.4.1 , 4.4.10 , 4.4.2 , 4.4.3 , 4.4.4 , 4.4.5 , 4.4.6 , 4.4.7 , 4.4.8 , 4.4.9 , 5.1.1 , 5.2.1 , 5.3.1 , 5.3.2 , 5.3.3 , 5.3.4 , 6.1.1 , 6.2.1 , 6.2.10 , 6.2.11 , 6.2.12 , 6.2.13 , 6.2.14 , 6.2.15 , 6.2.2 , 6.2.3 , 6.2.4 , 6.2.5 , 6.2.6 , 6.2.7 , 6.2.8 , 6.2.9 , 6.3.1 , 6.4.1 , 6.4.10 , 6.4.11 , 6.4.12 , 6.4.13 , 6.4.14 , 6.4.15 , 6.4.2 , 6.4.3 , 6.4.4 , 6.4.5 , 6.4.6 , 6.4.7 , 6.4.8 , 6.4.9 , 6.5.1.1 , 6.5.1.2 , 6.5.1.3 , 6.5.2 , 6.5.3 , 6.5.4 , 6.5.5 , 6.6.1 , 6.7.1 , 6.8.1 , 7.1.1 , 7.1.10 , 7.1.11 , 7.1.2 , 7.1.3 , 7.1.4 , 7.1.5 , 7.1.6 , 7.1.7 , 7.1.8 , 7.1.9 , 7.2.1 , 7.3.1 , 7.3.2 , 7.3.3 , 7.3.4 , 7.3.5 , 7.3.6 , 7.3.7
import clarus

response = clarus.ccpqd.reference()
print (response)
import com.clarusft.api.model.ccpqd.ReferenceRequest
import com.clarusft.api.model.ccpqd.ReferenceResponse

ApiClient clarus = ApiClient.getDefault();
ReferenceResponse response = clarus.request(new ReferenceRequest());
System.out.println(response);
import Clarus

response = Clarus.Ccpqd.reference()
print(response)

##
##Need to install packages once, if not already installed
##install.packages('httr')
##install.packages('readr')
##

library('httr')
##library('readr')

## Manually edit and set key/secret here ##
apiKey <- '...'
apiSecret <-'...'

request <- function(category, functionName, ...){
  restUrl  =  paste0('https://apieval.clarusft.com/api/rest/v1/', category, '/',functionName, '.csv')
  response <- POST(url=restUrl, body=list(...), encode='json', authenticate(apiKey, apiSecret, type='basic'))
  if (response$status_code!=200){
      stop(paste0('Request to ', category, '/', functionName, ' failed with status code: ', response$status_code))
  }
  return (response)
}

dataframe <- function(response){
  return (read.csv(text=content(response, 'text'), sep=',', head=TRUE))
}
## filename <- file.path('C:', 'Temp', 'myfile.csv')
## myvalue <- <- read_file(filename)

r <- request('ccpqd', 'Reference')
df <- dataframe(r)
print (df)

import requests
import sys
import pandas
import io
#import os

# Example of REST API call to Clarus Microservices #

# Manually edit and set key/secret here #
apiKey = ''
apiSecret = ''

print (sys.version)

def request(category, functionName, **params):
  restUrl = 'https://apieval.clarusft.com/api/rest/v1/' + category + '/' + functionName + '.json'
  r = requests.post(restUrl, json=params, auth=(apiKey, apiSecret))
  r.raise_for_status()
  return r.json()

def dataframe(results):
  return pandas.DataFrame(results['results'])

# filename = os.path.join('C:\\', 'Temp', 'myfile.csv')
# myvalue = open(filename).read()

r = request('ccpqd', 'Reference')
df = dataframe(r)
print(pandas.DataFrame.head(df))


use strict;
use warnings;
use MIME::Base64;
use JSON;
use REST::Client;

# Example of REST API call to Clarus Microservices #

my $client = REST::Client->new();
$client->addHeader('Content-Type', 'application/json');

# Manually edit and set key/secret here 
my $apiKey = '';
my $apiSecret = '';

my $encoded_auth = encode_base64("$apiKey:$apiSecret", '');
$client->addHeader('Authorization', "Basic $encoded_auth");

my %params = ();

my $urlBase = 'https://apieval.clarusft.com/api/rest/v1/';
my $category = 'ccpqd/';
my $name = 'Reference';
my $outputFormat = '.csv'; #can also be '.json' or '.tsv'
my $fullRESTUrl  =  $urlBase . $category . $name . $outputFormat;

$client->POST($fullRESTUrl,encode_json(\%params));

print 'Response: ' . $client->responseContent() . "\n";
print 'Response status: ' . $client->responseCode() . "\n";


printf('Example of REST API call to Clarus Microservices\n');

function r = request(category, functionName, params)

# Manually edit and set key/secret here #
  apiKey = ''
  apiSecret = ''

  restUrl = ['https://' apiKey ":" apiSecret  "@" 'apieval.clarusft.com/api/rest/v1/' category '/' functionName '.csv'];
  [r, status, message] = urlread (restUrl, 'get', params);
  if (status!=1)
      error(['Failed on ' category '/' functionName ': ' message]);
  endif
end

function ca = toCellArray(csvStr)
  header_row = textscan (csvStr, "%s", 1, 'delimiter','\n');
  headers = strsplit(char(header_row), ",");
  numCols = size(headers)(2);
  format = repmat('%s ', [1 numCols]);
  ca = textscan (csvStr, format, 'delimiter',',', 'endofline',"\n");
end

params = {}

r = request('ccpqd', 'Reference', params)
ca = toCellArray(r);

ca

Request Body

Submit to generate...
Response

Submit to generate...

{ }