Validate a counterparty import workbook.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators",
"file_name": "<string>",
"file_data": "<string>"
}
'import requests
url = "https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport"
payload = {
"$type": "Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators",
"file_name": "<string>",
"file_data": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
$type: 'Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators',
file_name: '<string>',
file_data: '<string>'
})
};
fetch('https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'$type' => 'Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators',
'file_name' => '<string>',
'file_data' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators\",\n \"file_name\": \"<string>\",\n \"file_data\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators\",\n \"file_name\": \"<string>\",\n \"file_data\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"$type\": \"Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators\",\n \"file_name\": \"<string>\",\n \"file_data\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationResponse, Derivitec.Core.Mediators",
"parsed_file_data": {
"$type": "Derivitec.Web.Models.CounterpartyParsedFileDataLite, Derivitec.Web.Models",
"file_name": "<string>",
"id": "<string>",
"message": "<string>",
"parse_errors": [
{
"$type": "Derivitec.Web.Core.ParseError, Derivitec.Web.Core",
"error_column": "<string>",
"error_columns": [
"<string>"
],
"message": "<string>",
"row": {
"row_error": "<string>",
"row_state": "detached",
"table": null,
"item_array": [
"<unknown>"
],
"has_errors": true
},
"tab": "<string>",
"error_level": "error"
}
],
"parse_warnings": [
{
"$type": "Derivitec.Web.Core.ParseError, Derivitec.Web.Core",
"error_column": "<string>",
"error_columns": [
"<string>"
],
"message": "<string>",
"row": {
"row_error": "<string>",
"row_state": "detached",
"table": null,
"item_array": [
"<unknown>"
],
"has_errors": true
},
"tab": "<string>",
"error_level": "error"
}
],
"table_messages": {},
"valid": true,
"counterparty_infos": [
{
"$type": "Derivitec.Web.Models.CounterpartyInfoImportViewModel, Derivitec.Web.Models",
"cash": 123,
"classification": "<string>",
"country": "<string>",
"credit": 123,
"currency": "<string>",
"date": "2023-11-07T05:31:56Z",
"desk": "<string>",
"identifier": "<string>",
"initial_margin": 123,
"initial_margin_requested": 123,
"is_checked": true,
"legal_entity_identifier": "<string>",
"limit": 123,
"margin_call_level": 123,
"margin_step": 123,
"margin_type": "absolute",
"name": "<string>",
"notional": 123,
"notional_options": 123,
"organisation_id": "<string>",
"parent_entity": "<string>",
"type": "bank",
"max_credit": 123,
"credit_pct": 123,
"initial_margin_pct": 123,
"limit_pct": 123,
"variation_margin": 123,
"variation_margin_pct": 123,
"string_label1": "<string>",
"string_label2": "<string>",
"string_label3": "<string>",
"action": "<string>",
"amend_cash": true,
"amend_classification": true,
"amend_country": true,
"amend_credit": true,
"amend_currency": true,
"amend_date": true,
"amend_desk": true,
"amend_initial_margin": true,
"amend_initial_margin_requested": true,
"amend_legal_entity_identifier": true,
"amend_limit": true,
"amend_margin_call_level": true,
"amend_margin_step": true,
"amend_margin_type": true,
"amend_name": true,
"amend_notional": true,
"amend_notional_options": true,
"amend_parent_entity": true,
"amend_max_credit": true,
"amend_credit_pct": true,
"amend_initial_margin_pct": true,
"amend_limit_pct": true,
"amend_variation_margin": true,
"amend_variation_margin_pct": true,
"amend_string_label1": true,
"amend_string_label2": true,
"amend_string_label3": true
}
],
"parse_warnings_lite": [
{
"$type": "Derivitec.Web.Models.ParseErrorLite, Derivitec.Web.Models",
"item_array": [
"<unknown>"
],
"message": "Input value is invalid.",
"error_column": "<string>",
"tab": "<string>",
"table_headers": [
"<string>"
]
}
],
"parse_errors_lite": [
{
"$type": "Derivitec.Web.Models.ParseErrorLite, Derivitec.Web.Models",
"item_array": [
"<unknown>"
],
"message": "Input value is invalid.",
"error_column": "<string>",
"tab": "<string>",
"table_headers": [
"<string>"
]
}
]
},
"is_success": true,
"error_messages": [
"<string>"
]
}Validate a counterparty import workbook.
Examines one counterparty workbook before any counterparty changes are applied. Review the returned
parsed rows, warnings, errors, and table messages before choosing to import. Workbook validity is reported
by ParsedFileData.Valid; a validation finding can be returned in a successful outer envelope.
This synchronous operation does not create, amend, or delete counterparties.
POST
/
api
/
Counterparties
/
ValidateImport
Validate a counterparty import workbook.
curl --request POST \
--url https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"$type": "Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators",
"file_name": "<string>",
"file_data": "<string>"
}
'import requests
url = "https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport"
payload = {
"$type": "Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators",
"file_name": "<string>",
"file_data": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
$type: 'Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators',
file_name: '<string>',
file_data: '<string>'
})
};
fetch('https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'$type' => 'Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators',
'file_name' => '<string>',
'file_data' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport"
payload := strings.NewReader("{\n \"$type\": \"Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators\",\n \"file_name\": \"<string>\",\n \"file_data\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"$type\": \"Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators\",\n \"file_name\": \"<string>\",\n \"file_data\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/Counterparties/ValidateImport")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"$type\": \"Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators\",\n \"file_name\": \"<string>\",\n \"file_data\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationResponse, Derivitec.Core.Mediators",
"parsed_file_data": {
"$type": "Derivitec.Web.Models.CounterpartyParsedFileDataLite, Derivitec.Web.Models",
"file_name": "<string>",
"id": "<string>",
"message": "<string>",
"parse_errors": [
{
"$type": "Derivitec.Web.Core.ParseError, Derivitec.Web.Core",
"error_column": "<string>",
"error_columns": [
"<string>"
],
"message": "<string>",
"row": {
"row_error": "<string>",
"row_state": "detached",
"table": null,
"item_array": [
"<unknown>"
],
"has_errors": true
},
"tab": "<string>",
"error_level": "error"
}
],
"parse_warnings": [
{
"$type": "Derivitec.Web.Core.ParseError, Derivitec.Web.Core",
"error_column": "<string>",
"error_columns": [
"<string>"
],
"message": "<string>",
"row": {
"row_error": "<string>",
"row_state": "detached",
"table": null,
"item_array": [
"<unknown>"
],
"has_errors": true
},
"tab": "<string>",
"error_level": "error"
}
],
"table_messages": {},
"valid": true,
"counterparty_infos": [
{
"$type": "Derivitec.Web.Models.CounterpartyInfoImportViewModel, Derivitec.Web.Models",
"cash": 123,
"classification": "<string>",
"country": "<string>",
"credit": 123,
"currency": "<string>",
"date": "2023-11-07T05:31:56Z",
"desk": "<string>",
"identifier": "<string>",
"initial_margin": 123,
"initial_margin_requested": 123,
"is_checked": true,
"legal_entity_identifier": "<string>",
"limit": 123,
"margin_call_level": 123,
"margin_step": 123,
"margin_type": "absolute",
"name": "<string>",
"notional": 123,
"notional_options": 123,
"organisation_id": "<string>",
"parent_entity": "<string>",
"type": "bank",
"max_credit": 123,
"credit_pct": 123,
"initial_margin_pct": 123,
"limit_pct": 123,
"variation_margin": 123,
"variation_margin_pct": 123,
"string_label1": "<string>",
"string_label2": "<string>",
"string_label3": "<string>",
"action": "<string>",
"amend_cash": true,
"amend_classification": true,
"amend_country": true,
"amend_credit": true,
"amend_currency": true,
"amend_date": true,
"amend_desk": true,
"amend_initial_margin": true,
"amend_initial_margin_requested": true,
"amend_legal_entity_identifier": true,
"amend_limit": true,
"amend_margin_call_level": true,
"amend_margin_step": true,
"amend_margin_type": true,
"amend_name": true,
"amend_notional": true,
"amend_notional_options": true,
"amend_parent_entity": true,
"amend_max_credit": true,
"amend_credit_pct": true,
"amend_initial_margin_pct": true,
"amend_limit_pct": true,
"amend_variation_margin": true,
"amend_variation_margin_pct": true,
"amend_string_label1": true,
"amend_string_label2": true,
"amend_string_label3": true
}
],
"parse_warnings_lite": [
{
"$type": "Derivitec.Web.Models.ParseErrorLite, Derivitec.Web.Models",
"item_array": [
"<unknown>"
],
"message": "Input value is invalid.",
"error_column": "<string>",
"tab": "<string>",
"table_headers": [
"<string>"
]
}
],
"parse_errors_lite": [
{
"$type": "Derivitec.Web.Models.ParseErrorLite, Derivitec.Web.Models",
"item_array": [
"<unknown>"
],
"message": "Input value is invalid.",
"error_column": "<string>",
"tab": "<string>",
"table_headers": [
"<string>"
]
}
]
},
"is_success": true,
"error_messages": [
"<string>"
]
}Authorizations
oauth2apikey
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
JSON request with FileName and required FileData as a data URL in the form data:<media-type>[;base64],<payload>. Base64 and URL-encoded payloads are accepted, and the workbook media type is application/vnd.openxmlformats-officedocument.spreadsheetml.sheet. No file-size limit is declared.
Request to validate an uploaded counterparty import file.
Available options:
Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationRequest, Derivitec.Core.Mediators Name supplied for the uploaded counterparty import file.
Data URL containing the uploaded counterparty import file contents.
Response
Returns parsed workbook rows, validation messages, and the file-validity result; malformed file data can be returned in an unsuccessful envelope.
Response containing parsed counterparty import data and validation findings.
Available options:
Derivitec.Core.Mediators.Upload.Counterparties.CounterpartyUploadValidationResponse, Derivitec.Core.Mediators Parsed counterparty-file result with compact errors and warnings.
Show child attributes
Show child attributes
Whether the operation completed successfully. The default is true; error outcomes set it to false.
Example:
true
Messages explaining operation-level failures. The collection is empty by default.
Was this page helpful?